ro.sync.ecss.extensions.commons.id
Class GenerateIDElementsInfo

java.lang.Object
  ro.sync.ecss.extensions.commons.id.GenerateIDElementsInfo

public class GenerateIDElementsInfo
extends java.lang.Object

Information about the list of elements for which to generate auto ID + if the auto ID generation is activated

Field Summary

static java.lang.String	DEFAULT_ID_GENERATION_PATTERN The default id generation pattern.
static java.lang.String	GENERATE_ID_ELEMENTS_ACTIVE_KEY The key from options
static java.lang.String	GENERATE_ID_ELEMENTS_KEY The key from options
static java.lang.String	GENERATE_ID_PATTERN_KEY The key from options
static java.lang.String	ID_PATTERN_DESCRIPTION Description for the id pattern macro.
static java.lang.String	ID_PATTERN_MACRO ID pattern macro.
static java.lang.String	LOCAL_NAME_PATTERN_DESCRIPTION Description for the local name pattern macro.
static java.lang.String	LOCAL_NAME_PATTERN_MACRO Local name pattern macro.
static java.lang.String	PATTERN_TOOLTIP The pattern tooltip
static java.lang.String	UUID_PATTERN_DESCRIPTION Description for the uuid pattern macro.
static java.lang.String	UUID_PATTERN_MACRO UUID pattern macro.

Constructor Summary

GenerateIDElementsInfo(AuthorAccess authorAccess, GenerateIDElementsInfo defaultOptions)
Constructor.

GenerateIDElementsInfo(boolean autoGenerateIds, java.lang.String idGenerationPattern, java.lang.String[] elementsWithIDGeneration)
Constructor.

Method Summary

static java.lang.String	generateID(java.lang.String idGenerationPattern, java.lang.String elementLocalName) Generate an ID from a pattern for the specified element.
static java.lang.String	generateUniqueID()
java.lang.String[]	getElementsWithIDGeneration()
java.lang.String	getIdGenerationPattern()
boolean	isAutoGenerateIDs()
void	saveToOptions(AuthorAccess authorAccess) Save to persistent options

Methods inherited from class java.lang.Object

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

Field Detail

GENERATE_ID_ELEMENTS_KEY

public static final java.lang.String GENERATE_ID_ELEMENTS_KEY

The key from options

See Also:

Constant Field Values

GENERATE_ID_ELEMENTS_ACTIVE_KEY

public static final java.lang.String GENERATE_ID_ELEMENTS_ACTIVE_KEY

The key from options

See Also:

Constant Field Values

GENERATE_ID_PATTERN_KEY

public static final java.lang.String GENERATE_ID_PATTERN_KEY

The key from options

See Also:

Constant Field Values

LOCAL_NAME_PATTERN_MACRO

public static final java.lang.String LOCAL_NAME_PATTERN_MACRO

Local name pattern macro.

See Also:

Constant Field Values

LOCAL_NAME_PATTERN_DESCRIPTION

public static final java.lang.String LOCAL_NAME_PATTERN_DESCRIPTION

Description for the local name pattern macro.

See Also:

Constant Field Values

UUID_PATTERN_MACRO

public static final java.lang.String UUID_PATTERN_MACRO

UUID pattern macro.

See Also:

Constant Field Values

ID_PATTERN_MACRO

public static final java.lang.String ID_PATTERN_MACRO

ID pattern macro.

See Also:

Constant Field Values

UUID_PATTERN_DESCRIPTION

public static final java.lang.String UUID_PATTERN_DESCRIPTION

Description for the uuid pattern macro.

See Also:

Constant Field Values

ID_PATTERN_DESCRIPTION

public static final java.lang.String ID_PATTERN_DESCRIPTION

Description for the id pattern macro.

See Also:

Constant Field Values

DEFAULT_ID_GENERATION_PATTERN

public static final java.lang.String DEFAULT_ID_GENERATION_PATTERN

The default id generation pattern.

See Also:

Constant Field Values

PATTERN_TOOLTIP

public static java.lang.String PATTERN_TOOLTIP

The pattern tooltip

Constructor Detail

GenerateIDElementsInfo

public GenerateIDElementsInfo(AuthorAccess authorAccess,
                              GenerateIDElementsInfo defaultOptions)

Constructor.

Parameters:

authorAccess - The author access

defaultOptions - The default options.

GenerateIDElementsInfo

public GenerateIDElementsInfo(boolean autoGenerateIds,
                              java.lang.String idGenerationPattern,
                              java.lang.String[] elementsWithIDGeneration)

Constructor.

Parameters:

autoGenerateIds - True to auto generate IDs

idGenerationPattern - The pattern for id generation.

elementsWithIDGeneration - List of elements for which to generate IDs

Method Detail

isAutoGenerateIDs

public boolean isAutoGenerateIDs()

Returns:

Returns true if auto generates IDs for elements.

getIdGenerationPattern

public java.lang.String getIdGenerationPattern()

Returns:

Returns the pattern for id generation.

getElementsWithIDGeneration

public java.lang.String[] getElementsWithIDGeneration()

Returns:

Returns the elements for which to generate IDs.

saveToOptions

public void saveToOptions(AuthorAccess authorAccess)

Save to persistent options

Parameters:

authorAccess - The author access

generateID

public static java.lang.String generateID(java.lang.String idGenerationPattern,
                                          java.lang.String elementLocalName)

Generate an ID from a pattern for the specified element.

Parameters:

idGenerationPattern - The pattern.

elementLocalName - The element local name

Returns:

The generated ID.

generateUniqueID

public static java.lang.String generateUniqueID()

Returns:

The generated Unique ID