org.nuiton.topia.persistence

Interface TopiaIdFactory

All Known Implementing Classes:

DefaultTopiaIdFactory, LegacyTopiaIdFactory

public interface TopiaIdFactory

This API represents an ID generation strategy

// TODO AThimel 20/07/13 Javadoc (finish this javadoc)

Since:

3.0

Author:

bleny , tchemit

Method Summary

Methods

Modifier and Type	Method and Description
<E extends TopiaEntity> Class<E>	getClassName(String topiaId)
String	getRandomPart(String topiaId)
String	getSeparator()
<E extends TopiaEntity> String	newTopiaId(Class<E> entityClass, TopiaEntity topiaEntity) Generates a new topia id for the given entity type and the given entity.

Method Detail

newTopiaId

<E extends TopiaEntity> String newTopiaId(Class<E> entityClass,
                                        TopiaEntity topiaEntity)

Generates a new topia id for the given entity type and the given entity.

Type Parameters:

E - type of entity

Parameters:

entityClass - type of entity (must be a not null interface)

topiaEntity - the entity on which we want to generate the id (must be not null)

Returns:

the new topia id for the given entity

getClassName

<E extends TopiaEntity> Class<E> getClassName(String topiaId)

Type Parameters:

E - type of the entity

Parameters:

topiaId - the topia id to inspect

Returns:

the fqn part of the topia id

getRandomPart

String getRandomPart(String topiaId)

Parameters:

topiaId - the topia id to inspect

Returns:

the random poart of the topia id.

getSeparator

String getSeparator()

Returns:

the separator between the fqn and the random part of any topia id.