org.cristalise.kernel.lookup

Class DomainPath

java.lang.Object

org.cristalise.kernel.lookup.Path

org.cristalise.kernel.lookup.DomainPath

All Implemented Interfaces:

C2KLocalObject

public class DomainPath
extends Path

Very simple extension to Path. Only copies constructors and defines root

Field Summary

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

delim, mPath

Constructor Summary

Constructors

Constructor and Description
DomainPath()
DomainPath(DomainPath parent, String child)
DomainPath(String path)
DomainPath(String[] path)
DomainPath(String path, ItemPath entity)

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
ItemPath	getItemPath()
String	getName() Retrieves the domain name of the path
DomainPath	getParent()
String	getRoot() Returns root as it is defined as 'domain', 'entity' or 'role' in subclasses
ItemPath	getTarget()
String	getTargetUUID()
boolean	isContext() Checks if the DomainPath represents a context node (i.e.
void	setItemPath(ItemPath newTarget)
void	setTargetUUID(String uuid)

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

dump, equals, exists, getClusterType, getIOR, getPath, getString, getStringPath, getSystemKey, getUUID, hashCode, setIOR, setName, setPath, setPath, setPath, 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

Constructor Detail

DomainPath

public DomainPath()

DomainPath

public DomainPath(String[] path)

DomainPath

public DomainPath(String path)

DomainPath

public DomainPath(String path,
                  ItemPath entity)

DomainPath

public DomainPath(DomainPath parent,
                  String child)

Method Detail

getRoot

public String getRoot()

Description copied from class: Path

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

Specified by:

getRoot in class Path

Returns:

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

getParent

public DomainPath getParent()

setItemPath

public void setItemPath(ItemPath newTarget)

getTarget

public ItemPath getTarget()

getItemPath

public ItemPath getItemPath()
                     throws ObjectNotFoundException

Overrides:

getItemPath in class Path

Throws:

ObjectNotFoundException

getTargetUUID

public String getTargetUUID()

setTargetUUID

public void setTargetUUID(String uuid)

isContext

public boolean isContext()

Checks if the DomainPath represents a context node (i.e. its target ItemPath is null). Use this method when target was set already.

Returns:

true if the DomainPath represents a context node

getName

public String getName()

Retrieves the domain name of the path

Returns:

the last path component;

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