org.opencms.loader

类 CmsDefaultFileNameGenerator

java.lang.Object

org.opencms.loader.CmsDefaultFileNameGenerator

所有已实现的接口:

I_CmsFileNameGenerator

public class CmsDefaultFileNameGenerator
extends java.lang.Object
implements I_CmsFileNameGenerator

The default class used for generating file names either for the urlName mapping or when using a "new" operation in the context of the direct edit interface.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
class	CmsDefaultFileNameGenerator.CmsNumberFactory Factory to use for resolving the %(number) macro.

字段概要

从接口继承的字段 org.opencms.loader.I_CmsFileNameGenerator

MACRO_NUMBER, NUMBER_FORMAT

构造器概要

构造器

构造器和说明
CmsDefaultFileNameGenerator()

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getNewFileName(CmsObject cms, java.lang.String namePattern, int defaultDigits) Returns a new resource name based on the provided OpenCms user context and name pattern.
protected java.lang.String	getNewFileNameFromList(java.util.List<java.lang.String> fileNames, java.lang.String checkPattern, int defaultDigits) Internal method for file name generation, decoupled for testing.
java.lang.String	getUniqueFileName(CmsObject cms, java.lang.String parentFolder, java.lang.String baseName) Returns a unique filename for the given base name and the parent folder.
java.util.Iterator<java.lang.String>	getUrlNameSequence(java.lang.String baseName) This default implementation will just generate a 5 digit sequence that is appended to the resource name in case of a collision of names.
static java.lang.String	removeExtension(java.lang.String path) Removes the file extension if it only consists of letters.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CmsDefaultFileNameGenerator

public CmsDefaultFileNameGenerator()

方法详细资料

removeExtension

public static java.lang.String removeExtension(java.lang.String path)

Removes the file extension if it only consists of letters.

参数:

path - the path from which to remove the file extension

返回:

the path without the file extension

getNewFileName

public java.lang.String getNewFileName(CmsObject cms,
                              java.lang.String namePattern,
                              int defaultDigits)
                                throws CmsException

Returns a new resource name based on the provided OpenCms user context and name pattern.

The pattern in this default implementation must be a path which may contain the macro %(number). This will be replaced by the first "n" digit sequence for which the resulting file name is not already used. For example the pattern "/file_%(number).xml" would result in something like "/file_00003.xml".

Alternatively, the macro can have the form %(number:n) with n = {1...9}, for example %(number:6). In this case the default digits will be ignored and instead the digits provided as "n" will be used.

指定者:

getNewFileName 在接口中 I_CmsFileNameGenerator

参数:

cms - the current OpenCms user context

namePattern - the pattern to be used when generating the new resource name

defaultDigits - the default number of digits to use for numbering the created file names

返回:

a new resource name based on the provided OpenCms user context and name pattern

抛出:

CmsException - in case something goes wrong

getUniqueFileName

public java.lang.String getUniqueFileName(CmsObject cms,
                                 java.lang.String parentFolder,
                                 java.lang.String baseName)

从接口复制的说明: I_CmsFileNameGenerator

Returns a unique filename for the given base name and the parent folder.

指定者:

getUniqueFileName 在接口中 I_CmsFileNameGenerator

参数:

cms - the current OpenCms user context

parentFolder - the parent folder of the file

baseName - the proposed file name

返回:

the unique file name

另请参阅:

I_CmsFileNameGenerator.getUniqueFileName(org.opencms.file.CmsObject, java.lang.String, java.lang.String)

getUrlNameSequence

public java.util.Iterator<java.lang.String> getUrlNameSequence(java.lang.String baseName)

This default implementation will just generate a 5 digit sequence that is appended to the resource name in case of a collision of names.

指定者:

getUrlNameSequence 在接口中 I_CmsFileNameGenerator

参数:

baseName - the base name

返回:

the sequence of URL name candidates

另请参阅:

I_CmsFileNameGenerator.getUrlNameSequence(java.lang.String)

getNewFileNameFromList

protected java.lang.String getNewFileNameFromList(java.util.List<java.lang.String> fileNames,
                                      java.lang.String checkPattern,
                                      int defaultDigits)

Internal method for file name generation, decoupled for testing.

参数:

fileNames - the list of file names already existing in the folder

checkPattern - the pattern to be used when generating the new resource name

defaultDigits - the default number of digits to use for numbering the created file names

返回:

a new resource name based on the provided OpenCms user context and name pattern