Package ca.uhn.hl7v2.parser

Class StructureDefinition

java.lang.Object

ca.uhn.hl7v2.parser.StructureDefinition

All Implemented Interfaces:

IStructureDefinition

public class StructureDefinition
extends Object
implements IStructureDefinition

Defines

Author:

James

Constructor Summary

Constructors

Constructor	Description
StructureDefinition()	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object theObj)
HashSet<String>	getAllChildNames()
HashSet<String>	getAllPossibleFirstChildren()	Returns the names of any possible children that could be the first required child of this group.
ArrayList<StructureDefinition>	getChildren()
IStructureDefinition	getFirstChild()
IStructureDefinition	getFirstSibling()
String	getName()
String	getNameAsItAppearsInParent()
Set<String>	getNamesOfAllPossibleFollowingLeaves()	Should only be called on a leaf node (segment).
IStructureDefinition	getNextLeaf()
IStructureDefinition	getNextSibling()
IStructureDefinition	getParent()
int	getPosition()
boolean	hasChildren()
int	hashCode()
boolean	isChoiceElement()
boolean	isFinalChildOfParent()
boolean	isRepeating()
boolean	isRequired()
boolean	isSegment()
void	setChoiceElement(boolean theChoiceElement)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

StructureDefinition

public StructureDefinition()

Constructor

Method Details

equals

public boolean equals(Object theObj)

Overrides:

equals in class Object

getAllChildNames

public HashSet<String> getAllChildNames()

Specified by:

getAllChildNames in interface IStructureDefinition

Returns:

Returns the names of all children of this structure, including first elements within child groups

getAllPossibleFirstChildren

public HashSet<String> getAllPossibleFirstChildren()

Returns the names of any possible children that could be the first required child of this group. For instance, for the group below "ORC" and "OBR" would both be returned, as they are both potential first children of this group. Note that the name returned by this.getName() is also returned. ORDER_OBSERVATION { [ ORC ] OBR [ { NTE } ] [ CTD ] OBSERVATION { [ OBX ] [ { NTE } ] } OBSERVATION [ { FT1 } ] [ { CTI } ] } ORDER_OBSERVATION

Specified by:

getAllPossibleFirstChildren in interface IStructureDefinition

Returns:

the names of any possible children that could be the first required child of this group

getChildren

public ArrayList<StructureDefinition> getChildren()

Specified by:

getChildren in interface IStructureDefinition

Returns:

Returns all children of this structure definition

getFirstChild

public IStructureDefinition getFirstChild()

Specified by:

getFirstChild in interface IStructureDefinition

Returns:

structure definition of first child of null if there is no child

getFirstSibling

public IStructureDefinition getFirstSibling()

Specified by:

getFirstSibling in interface IStructureDefinition

Returns:

Returns this structure's first sibling (in other words, its parent's first child). Returns null if this is the first sibling, or if this has no parent

getName

public String getName()

Specified by:

getName in interface IStructureDefinition

Returns:

Returns the name of this structure

getNameAsItAppearsInParent

public String getNameAsItAppearsInParent()

Specified by:

getNameAsItAppearsInParent in interface IStructureDefinition

Returns:

The name of the segment, as it is known to it's parent. This will differ from {IStructureDefinition.getName()} in the case of multiple segments with the same name in a group, e.g. the two PID segments in ADT_A17, where the second one it known as PID2 to it's parent.

getNamesOfAllPossibleFollowingLeaves

public Set<String> getNamesOfAllPossibleFollowingLeaves()

Should only be called on a leaf node (segment). Returns the names of all valid children which may follow this one, at any level in the hierarchy (including as later siblings of parent structures to this one)

Specified by:

getNamesOfAllPossibleFollowingLeaves in interface IStructureDefinition

Returns:

the names of all valid children which may follow this one

getNextLeaf

public IStructureDefinition getNextLeaf()

Specified by:

getNextLeaf in interface IStructureDefinition

Returns:

Returns the next leaf (segment) after this one, within the same group, only if one exists and this structure is also a leaf. Otherwise returns null.

getNextSibling

public IStructureDefinition getNextSibling()

Specified by:

getNextSibling in interface IStructureDefinition

Returns:

Returns this structure's next sibling within it's parent, if any.

getParent

public IStructureDefinition getParent()

Specified by:

getParent in interface IStructureDefinition

Returns:

Returns the parent structure of this structure, if one exists. Otherwise, returns null.

getPosition

public int getPosition()

Specified by:

getPosition in interface IStructureDefinition

Returns:

Returns the index of the position of this structure within it's parent's children

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface IStructureDefinition

Returns:

Does this structure have children (i.e. is it not a segment)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isFinalChildOfParent

public boolean isFinalChildOfParent()

Specified by:

isFinalChildOfParent in interface IStructureDefinition

Returns:

Returns true if this structure is the final child of it's parent.

isRepeating

public boolean isRepeating()

Specified by:

isRepeating in interface IStructureDefinition

Returns:

Returns true if this is a repeatable structure

isRequired

public boolean isRequired()

Specified by:

isRequired in interface IStructureDefinition

Returns:

true if this a required structure within it's parent

isSegment

public boolean isSegment()

Specified by:

isSegment in interface IStructureDefinition

Returns:

Returns true if this structure is a segment

toString

public String toString()

Overrides:

toString in class Object

setChoiceElement

public void setChoiceElement(boolean theChoiceElement)

Parameters:

theChoiceElement - true if the definition of this structure is a choice

See Also:

• Group.isChoiceElement(String)

isChoiceElement

public boolean isChoiceElement()

Specified by:

isChoiceElement in interface IStructureDefinition

Returns:

true if this element a choice element

See Also:

• Group.isChoiceElement(String)