eu.ehri.project.models.idgen

Interface IdGenerator

All Known Implementing Classes:

DescriptionIdGenerator, GenericIdGenerator, IdentifiableEntityIdGenerator

public interface IdGenerator

Generate an ID given an entity type, a set of scopes, and some data.

Method Summary

Modifier and Type	Method and Description
String	generateId(Collection<String> scopeIds, Bundle bundle) Generate an ID given an array of scope IDs.
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)

Method Detail

handleIdCollision

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

Parameters:

scopeIds - The entity's parent scope identifiers

bundle - The entity's bundle data

Returns:

A set of errors

generateId

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

Generate an ID given an array of scope IDs. This can be used where the scope might not yet exist.

Parameters:

scopeIds - An array of scope ids, ordered parent-to-child.

bundle - The entity's bundle data

Returns:

A generated ID string

getIdBase

String getIdBase(Bundle bundle)

Return the base data for the id, sans scoping.

Parameters:

bundle - The entity's bundle.

Returns:

The base id string.