org.jahia.content

Class CategoryKey

java.lang.Object

org.jahia.content.ObjectKey

org.jahia.content.CategoryKey

All Implemented Interfaces:

Serializable, Comparable<ObjectKey>, ObjectKeyInterface

public class CategoryKey
extends ObjectKey

Title: A ObjectKey class for categories

Description:

Copyright: Copyright (c) 2002

Company: Jahia Ltd

Version:

1.0

Author:

Serge Huber

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY_TYPE

Fields inherited from class org.jahia.content.ObjectKey

key, OBJECT_TYPE

Fields inherited from interface org.jahia.content.ObjectKeyInterface

KEY_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CategoryKey() Protected constructor to use this class also as a factory by calling the getChildInstance method
	CategoryKey(String categoryID)
	CategoryKey(String categoryID, String objectKey)

Method Summary

Modifier and Type	Method and Description
static Set<CategoryKey>	getCategories(String[] keys) Return a set of categories for the given array of String keys
int	getCategoryID() Deprecated. ObjectKey.getIDInType() should be used instead.
ObjectKey	getChildInstance(String IDInType, String objectKey) Factory method to create an instance of the corresponding ObjectKey implementation class.

Methods inherited from class org.jahia.content.ObjectKey

compareTo, equals, getIdInType, getIDInType, getInstance, getKey, getType, hashCode, toObjectKeyString, toString, unregisterType

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORY_TYPE

public static final String CATEGORY_TYPE

See Also:

Constant Field Values

Constructor Detail

CategoryKey

protected CategoryKey()

Protected constructor to use this class also as a factory by calling the getChildInstance method

CategoryKey

public CategoryKey(String categoryID)

CategoryKey

public CategoryKey(String categoryID,
                   String objectKey)

Method Detail

getCategoryID

public int getCategoryID()

Deprecated. ObjectKey.getIDInType() should be used instead.

getChildInstance

public ObjectKey getChildInstance(String IDInType,
                                  String objectKey)

Description copied from interface: ObjectKeyInterface

Factory method to create an instance of the corresponding ObjectKey implementation class. This is called by the ObjectKey.getInstance() method and should never be called directly.

Parameters:

IDInType - identifier within type

objectKey - the full ObjectKey string representation. This is an optimization to avoid having to rebuild it as when we call this method we already have it.

Returns:

an ObjectKey instance of the appropriate subclass.

getCategories

public static Set<CategoryKey> getCategories(String[] keys)

Return a set of categories for the given array of String keys

Parameters:

keys -

Returns: