org.openehr.rm.common.archetyped
Class Locatable

java.lang.Object
  org.openehr.rm.RMObject
      org.openehr.rm.common.archetyped.Locatable

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Address, Capability, Composition, Contact, ContentItem, DataStructure, EHR, Folder, Item, ItemEvent, MessageContent, Party, PartyIdentity, PartyRelationship, XFolder

public abstract class Locatable
extends RMObject

Root structural class of all information models. Instances of this class are immutalbe.

Version:

1.0

Author:

Rong Chen

See Also:

Serialized Form

Constructor Summary

protected	Locatable()
protected	Locatable(ObjectID uid, java.lang.String archetypeNodeId, DvText name, Archetyped archetypeDetails, FeederAudit feederAudit, java.util.Set<Link> links) Constructs a Locatable
protected	Locatable(java.lang.String archetypeNodeId, DvText name) Constructs a Locatable node by archetypeNodeId and name same as name

Method Summary

DvText	concept() Clinical concept of the archetype as a whole, derived from the archetypeNodeId of the root node
Archetyped	getArchetypeDetails() Details of archetyping used on this node.
java.lang.String	getArchetypeNodeId() Design-time archetype id of this node taken from its generating archetype; used to build archetype paths.
FeederAudit	getFeederAudit() Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.
java.util.Set<Link>	getLinks() Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on).
DvText	getName() Runtime name of this fragment, used to build runtime paths.
ObjectID	getUid() Optional globally unique object identifier for root object of archetyped data structure.
boolean	isArchetypeRoot() True if this node is the root of an archetyped structure
abstract Locatable	itemAtPath(java.lang.String path) The item at a path that is relative to this item.
abstract java.lang.String	pathOfItem(Locatable item) String The path to an item relative to the root of this archetyped structure.
protected void	setArchetypeDetails(Archetyped archetypeDetails)
protected void	setArchetypeNodeId(java.lang.String archetypeNodeId)
protected void	setFeederAudit(FeederAudit feederAudit)
protected void	setLinks(java.util.Set<Link> links)
protected void	setName(DvText name)
protected void	setUid(ObjectID uid)
java.lang.String	toString() Return sting presentation of this locatable
abstract boolean	validPath(java.lang.String path) Return true if the path is valid with respect to the current item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Locatable

protected Locatable(ObjectID uid,
                    java.lang.String archetypeNodeId,
                    DvText name,
                    Archetyped archetypeDetails,
                    FeederAudit feederAudit,
                    java.util.Set<Link> links)

Constructs a Locatable

Parameters:

uid - null if not specified

archetypeNodeId - not null

name - not null

archetypeDetails - null if not specified

feederAudit - null if not specified

links - null if not specified

Throws:

java.lang.IllegalArgumentException - if name null or archetypeNodeId null or links not null and empty

Locatable

protected Locatable(java.lang.String archetypeNodeId,
                    DvText name)

Constructs a Locatable node by archetypeNodeId and name same as name

Parameters:

archetypeNodeId -

name -

Throws:

java.lang.IllegalArgumentException - if archetypeNodeId or name null

Locatable

protected Locatable()

Method Detail

getUid

public ObjectID getUid()

Optional globally unique object identifier for root object of archetyped data structure.

Returns:

objectID nu

getArchetypeNodeId

public java.lang.String getArchetypeNodeId()

Design-time archetype id of this node taken from its generating archetype; used to build archetype paths. Always in the form of an "at" code, eg "at0005". This value enables a "standardised" name for this node to be generated, by referring to the generating archetype local ontology.

Returns:

archetypeNodeId

getName

public DvText getName()

Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.

Returns:

name

getArchetypeDetails

public Archetyped getArchetypeDetails()

Details of archetyping used on this node.

Returns:

archetype details

getFeederAudit

public FeederAudit getFeederAudit()

Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.

Returns:

feederAuidt

getLinks

public java.util.Set<Link> getLinks()

Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.

Returns:

links or null if unspecified

isArchetypeRoot

public boolean isArchetypeRoot()

True if this node is the root of an archetyped structure

Returns:

true if archetype root

pathOfItem

public abstract java.lang.String pathOfItem(Locatable item)

String The path to an item relative to the root of this archetyped structure.

Parameters:

item -

Returns:

string path

itemAtPath

public abstract Locatable itemAtPath(java.lang.String path)

The item at a path that is relative to this item.

Parameters:

path -

Returns:

relative path

validPath

public abstract boolean validPath(java.lang.String path)

Return true if the path is valid with respect to the current item.

Parameters:

path -

Returns:

true if valid

concept

public DvText concept()

Clinical concept of the archetype as a whole, derived from the archetypeNodeId of the root node

Returns:

archetyep concept

Throws:

java.lang.UnsupportedOperationException - if this node is not root

toString

public java.lang.String toString()

Return sting presentation of this locatable

Overrides:

toString in class java.lang.Object

Returns:

string presentation

setUid

protected void setUid(ObjectID uid)

setArchetypeNodeId

protected void setArchetypeNodeId(java.lang.String archetypeNodeId)

setName

protected void setName(DvText name)

setArchetypeDetails

protected void setArchetypeDetails(Archetyped archetypeDetails)

setFeederAudit

protected void setFeederAudit(FeederAudit feederAudit)

setLinks

protected void setLinks(java.util.Set<Link> links)