eu.ehri.project.models.idgen

Enum IdentifiableEntityIdGenerator

java.lang.Object

java.lang.Enum<IdentifiableEntityIdGenerator>

eu.ehri.project.models.idgen.IdentifiableEntityIdGenerator

All Implemented Interfaces:

IdGenerator, Serializable, Comparable<IdentifiableEntityIdGenerator>

public enum IdentifiableEntityIdGenerator
extends Enum<IdentifiableEntityIdGenerator>
implements IdGenerator

Generates an ID for nodes which represent IdentifiableEntities, where The graph id is derived from a property called "identifier".

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

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 IdentifiableEntityIdGenerator	valueOf(String name) Returns the enum constant of this type with the specified name.
static IdentifiableEntityIdGenerator[]	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 IdentifiableEntityIdGenerator INSTANCE

Method Detail

values

public static IdentifiableEntityIdGenerator[] 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 (IdentifiableEntityIdGenerator c : IdentifiableEntityIdGenerator.values())
    System.out.println(c);

Returns:

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

valueOf

public static IdentifiableEntityIdGenerator 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.

Specified by:

getIdBase in interface IdGenerator

Parameters:

bundle - The entity's bundle.

Returns:

The base id string.