net.sf.mmm.util.entity.base

Class EntityIdImpl

java.lang.Object

net.sf.mmm.util.entity.base.AbstractEntityId

net.sf.mmm.util.entity.base.EntityIdImpl

All Implemented Interfaces:

Serializable, EntityId, AttributeReadValue<String>, Datatype, SimpleDatatype<String>

public class EntityIdImpl
extends AbstractEntityId

This is the implementation of EntityId including identification of revision.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private long	objectId
private Number	revision
private static long	serialVersionUID UID for serialization.
private long	typeId

Fields inherited from interface net.sf.mmm.util.entity.api.EntityId

OBJECT_ID_ILLEGAL, OBJECT_ID_MINIMUM_CUSTOM, RADIX, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityIdImpl() The constructor for de-serialization in GWT.
	EntityIdImpl(EntityId entityId) The constructor.
	EntityIdImpl(long objectId, long typeId, Number revision) The constructor.
	EntityIdImpl(String idAsString) The constructor.

Method Summary

Modifier and Type	Method and Description
long	getObjectId() This method gets the unique identifier of an entity (or any other object).
Number	getRevision() This method gets the number of the specific revision of the object referenced by this EntityId.
long	getTypeId() This method gets the identifier representing the type of the referenced entity or object.

Methods inherited from class net.sf.mmm.util.entity.base.AbstractEntityId

equals, getValue, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

objectId

private long objectId

See Also:

getObjectId()

typeId

private long typeId

See Also:

getTypeId()

revision

private Number revision

See Also:

getRevision()

Constructor Detail

EntityIdImpl

protected EntityIdImpl()

The constructor for de-serialization in GWT.

EntityIdImpl

public EntityIdImpl(long objectId,
                    long typeId,
                    Number revision)

The constructor.

Parameters:

objectId - - see getObjectId().

typeId - - see getTypeId().

revision - - see getRevision().

EntityIdImpl

public EntityIdImpl(EntityId entityId)

The constructor.

Parameters:

entityId - is the EntityId instance to "clone".

EntityIdImpl

public EntityIdImpl(String idAsString)

The constructor.

Parameters:

idAsString - is the string representation of the EntityId to create.

Method Detail

getRevision

public Number getRevision()

This method gets the number of the specific revision of the object referenced by this EntityId. If the associated object is NOT version controlled (e.g. a class or field), then the revision will always be null.
Further a revision of null always points to the latest revision of an object.

Returns:

the revision or null for the latest revision.

See Also:

RevisionedEntity.getRevision(), RevisionedEntity.LATEST_REVISION

getTypeId

public long getTypeId()

This method gets the identifier representing the type of the referenced entity or object. The type is typically directly related to the Class reflecting the object. However, in dynamically or mixed typed object-worlds (often used in content-management-systems) two instances of the same java Class may be considered to have different types that can only be determined at runtime. To resolve an EntityId a central component is required that can map the EntityId.getTypeId() to the actual type (e.g. Class object) and vice versa.

Returns:

the classId.

getObjectId

public long getObjectId()

This method gets the unique identifier of an entity (or any other object).

Returns:

the object-id.

See Also:

GenericEntity.getId()