com.tridion.util

Class TCDURI

java.lang.Object

com.tridion.util.TCDURI

All Implemented Interfaces:

ObjectSizeProvider

public class TCDURI
extends Object
implements ObjectSizeProvider

The TCDURI class is used to parse and create URIs that identify items for the Content Delivery system. TCDURIs can be identified by the 'tcd:' namespace.

Delivery System XSLT with Id 24 within Publication 2: tcd:pub[2]/template[24]

A ComponentPresentation rendered using CMS Template 23 from Component 45 within Publication 15: tcd:pub[15]/componentpresentation[23,45]

This class implements CachedObject to provide cached objects such as BinaryMetaImpl with an estimate of the size of instances of this class.

Field Summary

Fields

Modifier and Type	Field and Description
static TCDURI	NULL_URI Null URI.
protected static HashMap<String,Long>	STRING_TO_TYPE
protected static HashMap<Long,String>	TYPE_TO_STRING
static String	URI_NAMESPACE URI namespace.

Constructor Summary

Constructors

Constructor and Description
TCDURI(int publicationId, long itemType, long itemId) Create a new TCDURI based on publicationId, itemType and itemId.
TCDURI(int publicationId, long itemType, long[] itemIds) Create a new TCDURI based on publicationId, itemType and itemIds.
TCDURI(int publicationId, long itemType, long[] itemIds, String variantId)
TCDURI(int publicationId, long itemType, long itemId, String variantId)
TCDURI(String uriString) Create a new TCDURI object from a String.
TCDURI(TCMURI uri) Create a TCDURI object from a TCMURI.
TCDURI(TCMURI uri, String variantId)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Compare two URI instances for equality.
long[]	getCompositeItemId() Get the itemIds if a composite key is used.
long	getItemId() Get the Item identifier.
long	getItemType() Get the type for this URI.
static long	getItemTypeId(String typeString) Get the ItemTypeId based on a type string.
String	getItemTypeString() Get the type for this URI as a human readable string.
static String	getItemTypeString(long itemType) Get an ItemType string for an ItemType Id.
int	getObjectSize() Estimates the size in bytes of this object and the objects that it owns.
int	getPublicationId() Get the Publication identifier.
String	getVariantId()
int	hashCode() Get the hashcode value of this URI.
String	toString() Convert the URI to a string.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_URI

public static final TCDURI NULL_URI

Null URI.

URI_NAMESPACE

public static final String URI_NAMESPACE

URI namespace.

See Also:

Constant Field Values

STRING_TO_TYPE

protected static final HashMap<String,Long> STRING_TO_TYPE

TYPE_TO_STRING

protected static final HashMap<Long,String> TYPE_TO_STRING

Constructor Detail

TCDURI

public TCDURI(TCMURI uri)

Create a TCDURI object from a TCMURI.

Parameters:

uri - A URI within the 'tcm:' namespace

TCDURI

public TCDURI(TCMURI uri,
              String variantId)

Parameters:

uri - A URI within the 'tcm:' namespace

variantId - the variant ID

TCDURI

public TCDURI(int publicationId,
              long itemType,
              long itemId)

Create a new TCDURI based on publicationId, itemType and itemId.

Parameters:

publicationId - Publication Id for this URI.

itemType - Type of the URI as defined in TCDItemTypes.

itemId - Id for the item.

See Also:

TCDItemTypes

TCDURI

public TCDURI(int publicationId,
              long itemType,
              long itemId,
              String variantId)

TCDURI

public TCDURI(int publicationId,
              long itemType,
              long[] itemIds)

Create a new TCDURI based on publicationId, itemType and itemIds.

Parameters:

publicationId - Publication Id for this URI.

itemType - Type of the URI as defined in TCDItemTypes.

itemIds - long array containing one or more itemIds.

See Also:

TCDItemTypes

TCDURI

public TCDURI(int publicationId,
              long itemType,
              long[] itemIds,
              String variantId)

TCDURI

public TCDURI(String uriString)
       throws ParseException

Create a new TCDURI object from a String.

Parameters:

uriString - String containing an unparsed TCDURI.

Throws:

ParseException - If the URI can't be parsed as a TCDURI.

Method Detail

getObjectSize

public int getObjectSize()

Estimates the size in bytes of this object and the objects that it owns.

Specified by:

getObjectSize in interface ObjectSizeProvider

Returns:

The size in bytes.

getPublicationId

public int getPublicationId()

Get the Publication identifier.

Returns:

publicationId

getItemId

public long getItemId()

Get the Item identifier.

Returns:

itemId

getCompositeItemId

public long[] getCompositeItemId()

Get the itemIds if a composite key is used.

Returns:

composite key

getItemType

public long getItemType()

Get the type for this URI.

Returns:

itemType

See Also:

TCDItemTypes

getVariantId

public String getVariantId()

getItemTypeString

public String getItemTypeString()

Get the type for this URI as a human readable string.

Returns:

itemType

See Also:

TCDItemTypes

toString

public String toString()

Convert the URI to a string.

Overrides:

toString in class Object

Returns:

string representation of the URI

equals

public boolean equals(Object other)

Compare two URI instances for equality.

Overrides:

equals in class Object

Parameters:

other - TCDURI to compare to.

Returns:

a boolean indicating if the other URI is equal.

hashCode

public int hashCode()

Get the hashcode value of this URI.

Overrides:

hashCode in class Object

Returns:

hashcode

getItemTypeId

public static long getItemTypeId(String typeString)

Get the ItemTypeId based on a type string.

Parameters:

typeString - String containing the type.

Returns:

an ItemTypeId

getItemTypeString

public static String getItemTypeString(long itemType)

Get an ItemType string for an ItemType Id.

Parameters:

itemType - ItemType Id.

Returns:

String if the ItemType is known or null if unknown.