com.sapportals.wcm.crt
Class ComponentUri

[contained in: com.sap.netweaver.bc.crt.par - bc.crt_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.crt.ComponentUri

public final class ComponentUri

extends java.lang.Object

A component URI (RFC2396 ) is an identifier for a component in the CRT.

Scheme: "crt"
Authority: The CRT client identifier
Path: Slash separated component keys (container hierarchie)
Query: Not used

This identifier is not relativ to a container like single component keys are but is a unique identifier for all components in the CRT system. The com.sapportals.wcm.repository.runtime.CmSystem#lookupComponentByUri method can be used to lookup a component instance for a given component URI.

Copyright (c) SAP AG 2001-2002

Field Summary

static java.lang.String	PATH_SEPARATOR
static java.lang.String	SCHEME

Method Summary

ComponentUri	appendKey(java.lang.String key) Appends the specified key at the end of the path.
boolean	equals(java.lang.Object other)
java.lang.String[]	getChildKeys() Returns all child keys of the child URIs of this URI.
ComponentUri	getChildUri(java.lang.String key) Returns a child URI with the specified key or null if it does not exist.
java.lang.String	getKey() Returns this URI's key
ComponentUri	getParent() Returns the parent URI.
static ComponentUri	getRootUri(java.lang.String clientID) Returns a new root component URI.
int	hashCode()
boolean	isRootUri() Returns true if this is a root URI.
ComponentUri	removeChildUri(java.lang.String key) Removes a child URI with the specified key.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEPARATOR

public static final java.lang.String PATH_SEPARATOR

SCHEME

public static final java.lang.String SCHEME

Method Detail

appendKey

public ComponentUri appendKey(java.lang.String key)
                       throws java.lang.IllegalArgumentException

Appends the specified key at the end of the path.

Parameters:

key - The component key to append.

Returns:

The new URI with the key added to the path.

Throws:

java.lang.IllegalArgumentException - If the key is invalid (e.g. contains invalid characters).

getParent

public ComponentUri getParent()

Returns the parent URI.

Returns:

the parent URI.

isRootUri

public boolean isRootUri()

Returns true if this is a root URI.

Returns:

true if this is a root URI.

getKey

public java.lang.String getKey()

Returns this URI's key

Returns:

this URI's key.

getChildUri

public ComponentUri getChildUri(java.lang.String key)

Returns a child URI with the specified key or null if it does not exist.

Parameters:

key - The key of the child URI.

Returns:

a child URI with the specified key or null if it does not exist.

removeChildUri

public ComponentUri removeChildUri(java.lang.String key)

Removes a child URI with the specified key.

Parameters:

key - The key of the child uri

Returns:

The removed URI or null if it does not exist.

getChildKeys

public java.lang.String[] getChildKeys()

Returns all child keys of the child URIs of this URI.

Returns:

all child keys of the child URIs of this URI.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRootUri

public static ComponentUri getRootUri(java.lang.String clientID)

Returns a new root component URI.

Parameters:

clientID - The CRT client identifier.

Returns:

a new root component URI.