com.tridion.util

Class CMURI

java.lang.Object

com.tridion.util.CMURI

All Implemented Interfaces:

Comparable<CMURI>

Direct Known Subclasses:

TCMURI

public class CMURI
extends Object
implements Comparable<CMURI>

This class represents a CMURI object.

This object is a helper object used to parse and create Content Manager (TCM or ISH) URIs.

Field Summary

Fields

Modifier and Type	Field and Description
static CMURI	NULL_URI Null URI.

Constructor Summary

Constructors

Constructor and Description
CMURI(String uri) Create a new URI from a string.
CMURI(String namespace, int publicationId, int itemId, int itemType, int version) Create a new URI based on namespace, publication Id, item Id, item type and version.

Method Summary

Modifier and Type	Method and Description
int	compareTo(CMURI other)
boolean	equals(Object object) Overridden implementation of equals() method in Object.
int	getItemId() Get the item Id for this URI.
int	getItemType() Get the item type for this URI.
String	getNamespace()
int	getPublicationId() Get the publicationId for this URI.
int	getVersion() Get the version for this URI.
int	hashCode() Overridden implementation of hashCode() in Object.
protected boolean	isNullUri() Check if this object is NULL_URI.
protected void	load(String uriString) This method is used to create a CMURI based on a String URI.
void	setItemId(int itemId) Sets the itemId.
void	setItemType(int itemType) Sets the itemType.
void	setNamespace(String namespace)
void	setPublicationId(int thePubId) Sets the publicationId.
void	setVersion(int version) Sets the version.
String	toString() Overridden implementation of toString() in Object.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_URI

public static final CMURI NULL_URI

Null URI. Defaulting to TCM namespace.

Constructor Detail

CMURI

public CMURI(String namespace,
             int publicationId,
             int itemId,
             int itemType,
             int version)

Create a new URI based on namespace, publication Id, item Id, item type and version.

Parameters:

namespace - namespace for this URI.

publicationId - publicationId for this URI.

itemId - itemId for this URI.

itemType - itemType for this URI.

version - version for this URI.

See Also:

ItemTypes

CMURI

public CMURI(String uri)
      throws ParseException

Create a new URI from a string.

Parameters:

uri - String containing the URI to be parsed.

Throws:

ParseException - Thrown if the String does not contain a valid CMURI

Method Detail

load

protected void load(String uriString)
             throws ParseException

This method is used to create a CMURI based on a String URI.

Parameters:

uriString - String representation of the URI. Format: namespacePrefix:pubId-itemId-itemType Example: "tcm:6-228-64"

Throws:

ParseException - Thrown if the String does not contain a valid CMURI

toString

public String toString()

Overridden implementation of toString() in Object.

Overrides:

toString in class Object

Returns:

A string representation of this CMURI.

setNamespace

public void setNamespace(String namespace)

getNamespace

public String getNamespace()

getItemType

public int getItemType()

Get the item type for this URI.

Returns:

The type identifier.

See Also:

ItemTypes

setItemType

public void setItemType(int itemType)

Sets the itemType.

Parameters:

itemType - The new itemType.

getItemId

public int getItemId()

Get the item Id for this URI.

Returns:

The item Id.

setItemId

public void setItemId(int itemId)

Sets the itemId.

Parameters:

itemId - The new itemId

getPublicationId

public int getPublicationId()

Get the publicationId for this URI.

Returns:

the publication Id.

setPublicationId

public void setPublicationId(int thePubId)

Sets the publicationId.

Parameters:

thePubId - The new publicationId.

getVersion

public int getVersion()

Get the version for this URI.

Returns:

The version.

setVersion

public void setVersion(int version)

Sets the version.

Parameters:

version - the new version.

isNullUri

protected boolean isNullUri()

Check if this object is NULL_URI.

Returns:

true if this object is NULL_URI, false otherwise.

equals

public boolean equals(Object object)

Overridden implementation of equals() method in Object.

Overrides:

equals in class Object

Parameters:

object - The reference object with which to compare.

Returns:

true if this object is the same as passed Object; false otherwise.

hashCode

public int hashCode()

Overridden implementation of hashCode() in Object.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

compareTo

public int compareTo(CMURI other)

Specified by:

compareTo in interface Comparable<CMURI>