org.cristalise.kernel.lookup

Class ItemPath

java.lang.Object

org.cristalise.kernel.lookup.Path

org.cristalise.kernel.lookup.ItemPath

All Implemented Interfaces:

C2KLocalObject

Direct Known Subclasses:

AgentPath

public class ItemPath
extends Path

Extends Path to enforce SystemKey structure and support UUID form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mIOR

Fields inherited from class org.cristalise.kernel.lookup.Path

delim, mPath

Constructor Summary

Constructors

Constructor and Description
ItemPath()
ItemPath(String path)
ItemPath(String[] path)
ItemPath(SystemKey syskey)
ItemPath(UUID uuid)
ItemPath(UUID uuid, String ior)

Method Summary

Modifier and Type	Method and Description
String	getClusterPath() Each C2KLocalObject is stored with a path identifier starting with the ClusterType: Properties: /Property/Name Workflow: /LifeCycle/workflow Collections: /Collection/Name/Version (default Name='last') Outcomes: /Outcome/SchemaName/SchemaVersion/EventID Viewpoints: /ViewPoint/SchemaName/Name (default Name='last') Events: /AuditTrail/EventID Jobs: /Job/JobID
Object	getIOR()
String	getIORString()
ItemPath	getItemPath()
String	getName() Gets the name of the C2KLocalObject
byte[]	getOID()
String	getRoot() The root of ItemPath is /entity
SystemKey	getSystemKey()
UUID	getUUID()
static boolean	isUUID(String entityKey)
void	setIOR(Object IOR)
void	setIORString(String ior)
void	setPath(Path path) clones the path object
void	setPath(String path)
void	setPath(String[] path) String array path e.g.
protected void	setSysKey(SystemKey sysKey)
protected void	setSysKey(UUID uuid)

Methods inherited from class org.cristalise.kernel.lookup.Path

dump, equals, exists, getClusterType, getPath, getString, getStringPath, hashCode, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cristalise.kernel.entity.C2KLocalObject

enforceValidName

Field Detail

mIOR

protected String mIOR

Constructor Detail

ItemPath

public ItemPath()

ItemPath

public ItemPath(UUID uuid,
                String ior)

ItemPath

public ItemPath(UUID uuid)

ItemPath

public ItemPath(SystemKey syskey)

ItemPath

public ItemPath(String[] path)
         throws InvalidItemPathException

Throws:

InvalidItemPathException

ItemPath

public ItemPath(String path)
         throws InvalidItemPathException

Throws:

InvalidItemPathException

Method Detail

setPath

public void setPath(String[] path)

Description copied from class: Path

String array path e.g. { "Product", "Crystal", "Barrel", "2L", "331013013348" }. The root node name (i.e. entity, domain or role) is removed from the beginning.

Overrides:

setPath in class Path

setPath

public void setPath(String path)

Overrides:

setPath in class Path

setPath

public void setPath(Path path)

Description copied from class: Path

clones the path object

Overrides:

setPath in class Path

getRoot

public String getRoot()

The root of ItemPath is /entity

Specified by:

getRoot in class Path

Returns:

root as it is defined as 'domain', 'entity' or 'role' in subclasses

getItemPath

public ItemPath getItemPath()
                     throws ObjectNotFoundException

Overrides:

getItemPath in class Path

Throws:

ObjectNotFoundException

getIOR

public Object getIOR()

Overrides:

getIOR in class Path

setIOR

public void setIOR(Object IOR)

Overrides:

setIOR in class Path

getIORString

public String getIORString()

setIORString

public void setIORString(String ior)

getOID

public byte[] getOID()

setSysKey

protected void setSysKey(UUID uuid)

setSysKey

protected void setSysKey(SystemKey sysKey)

getSystemKey

public SystemKey getSystemKey()

Overrides:

getSystemKey in class Path

getUUID

public UUID getUUID()

Overrides:

getUUID in class Path

getName

public String getName()

Description copied from interface: C2KLocalObject

Gets the name of the C2KLocalObject

Returns:

name of the C2KLocalObject

getClusterPath

public String getClusterPath()

Description copied from interface: C2KLocalObject

Each C2KLocalObject is stored with a path identifier starting with the ClusterType:

• Properties: /Property/Name
• Workflow: /LifeCycle/workflow
• Collections: /Collection/Name/Version (default Name='last')
• Outcomes: /Outcome/SchemaName/SchemaVersion/EventID
• Viewpoints: /ViewPoint/SchemaName/Name (default Name='last')
• Events: /AuditTrail/EventID
• Jobs: /Job/JobID

Returns:

The path identifier (i.e. primary key) of the object

isUUID

public static boolean isUUID(String entityKey)