org.jahia.content

Class ObjectKey

java.lang.Object

org.jahia.content.ObjectKey

All Implemented Interfaces:

Serializable, Comparable<ObjectKey>, ObjectKeyInterface

Direct Known Subclasses:

CategoryKey, EntryPointObjectKey

public abstract class ObjectKey
extends Object
implements ObjectKeyInterface, Serializable, Comparable<ObjectKey>

The purpose of this class is to construct ContentObject references that can be used both externally and internally to references Jahia content objects such as fields, containers, pages and other objects... The tentative format of this key is (subject to change in order to comply with existing norms) : type_IDInType where type is a String specifying the type of the object, while the IDInType is an integer that specifies which instances of the specific object type.

Author:

Serge Huber

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	key
static String	OBJECT_TYPE

Fields inherited from interface org.jahia.content.ObjectKeyInterface

KEY_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectKey() Making default constructor protected, should not be used, except for factory objects
protected	ObjectKey(String type, String IDInType) Object constructor method.
protected	ObjectKey(String type, String IDInType, String key) Optimized constructor, for calls where we have both the seperate and constructed key.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ObjectKey destObjectKey) Implementation of the comparable interface so that object keys may be used in sets that need a comparable interface.
boolean	equals(Object obj) Redefinition of the equality comparison, since ObjectKey objects are very likely to be used as keys in Maps, or other ordered sets, maps or lists.
int	getIdInType() Deprecated. getIDInType() should be used instead.
String	getIDInType() Returns a String that represents an identifier for a content object within a type.
static ObjectKey	getInstance(String key) Instance generator.
String	getKey() Returns the actual key of the content object.
String	getType() Returns a type identifier for a content object.
int	hashCode() Hash code implementation to make object compatible with hash table usage.
static String	toObjectKeyString(String type, String IDInType) Optimized method to generate ObjectKey strings without the overhead of creating an ObjectKey object.
String	toString() Converts the object to a string only to be used for debug display, not serialization !
static void	unregisterType(String type) Removes a type registration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jahia.content.ObjectKeyInterface

getChildInstance

Field Detail

OBJECT_TYPE

public static final String OBJECT_TYPE

See Also:

Constant Field Values

key

protected final String key

Constructor Detail

ObjectKey

protected ObjectKey()

Making default constructor protected, should not be used, except for factory objects

ObjectKey

protected ObjectKey(String type,
                    String IDInType)

Object constructor method.

Parameters:

type - a String specifying the object type. Normally this is used mostly by children of this class but could be used for some "hacks".

IDInType - the unique identifier within the type.

ObjectKey

protected ObjectKey(String type,
                    String IDInType,
                    String key)

Optimized constructor, for calls where we have both the seperate and constructed key.

Parameters:

type - a String specifying the object type. Normally this is used mostly by children of this class but could be used for some "hacks".

IDInType - the unique identifier within the type.

key - the combined object key of the type and the IDInType. This is generated with type + KEY_SEPARATOR + IDInType

Method Detail

unregisterType

public static void unregisterType(String type)

Removes a type registration. See the registerType method for more details

Parameters:

type - the name of the type to unregister

getInstance

public static ObjectKey getInstance(String key)
                             throws ClassNotFoundException

Instance generator. Uses a string representation of the key to extract the type and IDInType parameters. Build an instance of the appropriate class corresponding to the type described.

Parameters:

key - a String in the format : type + KEY_SEPARATOR + IDInType

Returns:

an ObjectKey sub class instance that corresponds to the given key.

Throws:

ClassNotFoundException - if no class could be found for the type passed in parameter.

getKey

public String getKey()

Description copied from interface: ObjectKeyInterface

Returns the actual key of the content object. This is a key that is unique within a Jahia installation, regardless of the sites, the pages we are on, etc..

Specified by:

getKey in interface ObjectKeyInterface

Returns:

a String containing a content object unique key, in the form of something like this : type_IDInType

getType

public String getType()

Description copied from interface: ObjectKeyInterface

Returns a type identifier for a content object. This can also be thought of as the "class" of the object.

Specified by:

getType in interface ObjectKeyInterface

Returns:

a String representing the type identifier of the content object key

getIDInType

public String getIDInType()

Description copied from interface: ObjectKeyInterface

Returns a String that represents an identifier for a content object within a type. This might also be thought of as the "instance" of the content object of a certain type (or "class").

Specified by:

getIDInType in interface ObjectKeyInterface

Returns:

an String representing the identifier within the type of the content object key

getIdInType

public int getIdInType()

Deprecated. getIDInType() should be used instead.

equals

public boolean equals(Object obj)

Redefinition of the equality comparison, since ObjectKey objects are very likely to be used as keys in Maps, or other ordered sets, maps or lists.

Overrides:

equals in class Object

Parameters:

obj - the Object to compare this object to.

Returns:

true if the object is an instance of the ObjectKey class and the value of the key is the same, false otherwise.

compareTo

public int compareTo(ObjectKey destObjectKey)
              throws ClassCastException

Implementation of the comparable interface so that object keys may be used in sets that need a comparable interface.

Specified by:

compareTo in interface Comparable<ObjectKey>

Returns:

a negative integer, zero, or a positive integer as this object's key string is less than, equal to, or greater than the specified object key string

Throws:

ClassCastException - thrown if the parameter is not of the ObjectKey type.

hashCode

public int hashCode()

Hash code implementation to make object compatible with hash table usage.

Overrides:

hashCode in class Object

Returns:

an unique hash code for a unique key.

toString

public String toString()

Converts the object to a string only to be used for debug display, not serialization !

Overrides:

toString in class Object

Returns:

a String containing the object key.

toObjectKeyString

public static String toObjectKeyString(String type,
                                       String IDInType)

Optimized method to generate ObjectKey strings without the overhead of creating an ObjectKey object.

Parameters:

type - the objectKey type

IDInType - the identifier in the type for the objectKey

Returns:

a String that represents the key