org.fulib.yaml

Class IdMap

java.lang.Object

org.fulib.yaml.IdMap

Direct Known Subclasses:

YamlIdMap

public class IdMap
extends java.lang.Object

The IdMap maintains an one-to-one mapping from objects to IDs. IDs are either automatically generated based on id or name properties or class names (see putObject(Object), or explicitly definied (with putObject(Object). Auto-generated IDs are suffixed with a running number if necessary.

Since:

1.2

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.LinkedHashMap<java.lang.Object,java.lang.String>	idObjMap
protected int	maxUsedIdNum
protected java.util.LinkedHashMap<java.lang.String,java.lang.Object>	objIdMap
protected ReflectorMap	reflectorMap
protected java.lang.String	userId

Constructor Summary

Constructors

Constructor and Description
IdMap(ReflectorMap reflectorMap)

Method Summary

Modifier and Type	Method and Description
void	discoverObjects(java.util.Collection<?> roots) Discovers all objects reachable from the roots and within the packages managed by the ReflectorMap that was given in the constructor, and adds them via putObject(Object).
void	discoverObjects(java.lang.Object... roots) Discovers all objects reachable from the roots and within the packages managed by the ReflectorMap that was given in the constructor, and adds them via putObject(Object).
void	discoverObjects(java.lang.Object root) Discovers all objects reachable from the root and within the packages managed by the ReflectorMap that was given in the constructor, and adds them via putObject(Object).
java.lang.String	getId(java.lang.Object object)
java.lang.Object	getObject(java.lang.String id)
Reflector	getReflector(java.lang.Object object)
java.lang.String	getUserId()
java.lang.String	putObject(java.lang.Object object) Adds the object with an automatically generated ID.
void	putObject(java.lang.String id, java.lang.Object object) Adds the object with the given id.
void	setUserId(java.lang.String userId)

Methods inherited from class java.lang.Object

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

Field Detail

reflectorMap

protected final ReflectorMap reflectorMap

userId

protected java.lang.String userId

maxUsedIdNum

protected int maxUsedIdNum

objIdMap

protected final java.util.LinkedHashMap<java.lang.String,java.lang.Object> objIdMap

idObjMap

protected final java.util.LinkedHashMap<java.lang.Object,java.lang.String> idObjMap

Constructor Detail

IdMap

public IdMap(ReflectorMap reflectorMap)

Method Detail

getUserId

public java.lang.String getUserId()

setUserId

public void setUserId(java.lang.String userId)

getReflector

public Reflector getReflector(java.lang.Object object)

Parameters:

object - the object

Returns:

a reflector corresponding to the given object's class, as given by ReflectorMap.getReflector(Object)

getId

public java.lang.String getId(java.lang.Object object)

Parameters:

object - the object

Returns:

the id of the given object, or null if not found

getObject

public java.lang.Object getObject(java.lang.String id)

Parameters:

id - the id

Returns:

the object with the given id, or null if not found

putObject

public java.lang.String putObject(java.lang.Object object)

Adds the object with an automatically generated ID. It is generated as follows:

1. If the object has a getId() method, we use that as the base ID by replacing any non-word characters (regex \W) with _.
2. If the object has no getId() method but a getName() method, the base ID becomes the result of that with the same replacement applied
3. Otherwise, the base ID is the first character of the simple name of the object's class

Then,

1. the base ID's first character is converted to lowercase
2. if an object is already present under the base ID, a running number is appended
3. if a user ID is specified and the object is not the first to be added, the user ID followed by a period are prepended to the base ID

Parameters:

object - the object to add

Returns:

the auto-generated ID

putObject

public void putObject(java.lang.String id,
                      java.lang.Object object)

Adds the object with the given id. If there is already an object with that id, the old object is removed.

Parameters:

id - the id

object - the object

discoverObjects

public void discoverObjects(java.lang.Object root)

Discovers all objects reachable from the root and within the packages managed by the ReflectorMap that was given in the constructor, and adds them via putObject(Object).

Parameters:

root - the root object

See Also:

ReflectorMap.discoverObjects(Object)

discoverObjects

public void discoverObjects(java.lang.Object... roots)

Discovers all objects reachable from the roots and within the packages managed by the ReflectorMap that was given in the constructor, and adds them via putObject(Object).

Parameters:

roots - the root objects

See Also:

ReflectorMap.discoverObjects(Object...)

discoverObjects

public void discoverObjects(java.util.Collection<?> roots)

Discovers all objects reachable from the roots and within the packages managed by the ReflectorMap that was given in the constructor, and adds them via putObject(Object).

Parameters:

roots - the root objects

See Also:

ReflectorMap.discoverObjects(Collection)