eu.ehri.project.models.idgen

Enum DescriptionIdGenerator

java.lang.Object

java.lang.Enum<DescriptionIdGenerator>

eu.ehri.project.models.idgen.DescriptionIdGenerator

All Implemented Interfaces:

IdGenerator, Serializable, Comparable<DescriptionIdGenerator>

public enum DescriptionIdGenerator
extends Enum<DescriptionIdGenerator>
implements IdGenerator

Generates an ID for nodes which represent Descriptions, where the graph id is a combination of the parent scopes, plus the description language code, plus an optional description identifier (say, 'alt').

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION_SEPARATOR
static com.google.common.base.Joiner	descriptionJoiner

Method Summary

Modifier and Type	Method and Description
String	generateId(Collection<String> scopeIds, Bundle bundle) Use an array of scope IDs and the bundle data to generate a unique id within a given scope.
String	getIdBase(Bundle bundle) Return the base data for the id, sans scoping.
com.google.common.collect.ListMultimap<String,String>	handleIdCollision(Collection<String> scopeIds, Bundle bundle)
static DescriptionIdGenerator	valueOf(String name) Returns the enum constant of this type with the specified name.
static DescriptionIdGenerator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final DescriptionIdGenerator INSTANCE

Field Detail

DESCRIPTION_SEPARATOR

public static final String DESCRIPTION_SEPARATOR

See Also:

Constant Field Values

descriptionJoiner

public static final com.google.common.base.Joiner descriptionJoiner

Method Detail

values

public static DescriptionIdGenerator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DescriptionIdGenerator c : DescriptionIdGenerator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DescriptionIdGenerator valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

handleIdCollision

public com.google.common.collect.ListMultimap<String,String> handleIdCollision(Collection<String> scopeIds,
                                                                               Bundle bundle)

Specified by:

handleIdCollision in interface IdGenerator

Parameters:

scopeIds - The entity's parent scope identifiers

bundle - The entity's bundle data

Returns:

A set of errors

generateId

public String generateId(Collection<String> scopeIds,
                         Bundle bundle)

Use an array of scope IDs and the bundle data to generate a unique id within a given scope.

Specified by:

generateId in interface IdGenerator

Parameters:

scopeIds - An array of scope ids

bundle - The bundle

Returns:

The calculated identifier

getIdBase

public String getIdBase(Bundle bundle)

Return the base data for the id, sans scoping. If the bundle contains a language of description, it comes first. If the bundle has a non-empty identifier, it is used too.

Specified by:

getIdBase in interface IdGenerator

Parameters:

bundle - The entity's bundle.

Returns:

The base id string, consisting of language code and/or identifier.