com.pixelmed.dicom

Class ContentItem

java.lang.Object

com.pixelmed.dicom.ContentItem

All Implemented Interfaces:

TreeNode

Direct Known Subclasses:

ContentItemWithReference, ContentItemWithValue

public abstract class ContentItem
extends Object
implements TreeNode

An abstract class for representing a node in an internal representation of a structured reporting tree (an instance of StructuredReport).

The constructor is protected. Instances of specific types of content items should normally be created by using the ContentItemFactory.

See Also:

ContentItemFactory, ContentItemWithValue, ContentItemWithReference, StructuredReport, StructuredReportBrowser

Field Summary

Fields

Modifier and Type	Field and Description
protected String	observationDateTime
protected String	observationUID
protected String	relationshipType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContentItem(ContentItem p, AttributeList l) Construct a content item for a list of attributes, and add it as a child of the specified parent.
protected	ContentItem(ContentItem p, String relationshipType) Construct a content item of a specified type and relationship, creating a new AttributeList, and add it as a child of the specified parent.
protected	ContentItem(ContentItem p, String relationshipType, String observationDateTime, String observationUID) Construct a content item of a specified type and relationship, creating a new AttributeList, and add it as a child of the specified parent.

Method Summary

Modifier and Type	Method and Description
void	addChild(ContentItem child) Add a child to this content item.
void	addSibling(ContentItem sibling) Add a sibling to this content item (a child to the parent of this content item).
Enumeration	children() Returns the children of this node as an Enumeration.
static boolean	contentItemNameMatchesCodeValueAndCodingSchemeDesignator(ContentItem ci, String cvWanted, String csdWanted) Test if the coded concept name of the content item matches the specified code value and coding scheme designator.
abstract boolean	contentItemNameMatchesCodeValueAndCodingSchemeDesignator(String cvWanted, String csdWanted) Test if the coded concept name of the content item matches the specified code value and coding scheme designator.
boolean	getAllowsChildren() Always returns true, since children may always be added.
AttributeList	getAttributeList() Get the attribute list of this content item.
TreeNode	getChildAt(int index) Returns the child at the specified index.
int	getChildCount() Return the number of children that this node contains.
CodedSequenceItem	getConceptName() Get the Concept Name.
String	getConceptNameAndValue() Get a string representation of the concept name and the value of the concept.
String	getConceptNameCodeMeaning() Get the value of the code meaning of the Concept Name as a string, if present and applicable.
String	getConceptNameCodeValue() Get the value of the code value of the Concept Name as a string, if present and applicable.
String	getConceptNameCodingSchemeDesignator() Get the value of the coding scheme designator of the Concept Name as a string, if present and applicable.
abstract String	getConceptValue() Get a string representation of the value of the concept.
float[]	getGraphicData() Get the Graphic Data of this content item, if present and applicable.
String	getGraphicType() Get the Graphic Type of this content item, if present and applicable.
int	getIndex(TreeNode child) Returns the index of the specified child from amongst this node's children, if present.
ContentItem	getNamedChild(CodedSequenceItem item) Retrieve the named child as defined by its ConceptName The code meaning of the concept is ignored, and only the code value and coding scheme designator are compared in the search.
ContentItem	getNamedChild(String codingSchemeDesignator, String codeValue) Retrieve the named child as defined by its ConceptName
String	getObservationDateTime() Get the ObservationDateTime of this content item.
String	getObservationUID() Get the ObservationUID of this content item.
TreeNode	getParent() Returns the parent node of this node.
ContentItem	getParentAsContentItem() Get the parent content item of this content item.
String	getPositionInTreeToUseAsReferencedContentItemIdentifier() Get the position in the tree relative to the top parent as a String to use as a Referenced Content Item Identifier.
String	getReferencedContentItemIdentifier() Get the Referenced Content Item Identifier, if present.
int[]	getReferencedContentItemIdentifierArray() Get the Referenced Content Item Identifier, if present.
String	getReferencedSOPClassUID() Get the Referenced SOP Class UID of this content item, if present and applicable.
String	getReferencedSOPInstanceUID() Get the Referenced SOP Instance UID of this content item, if present and applicable.
String	getRelationshipType() Get the relationship type of this content item.
String	getSingleStringValueOrNull() Retrieve the string value of self
static String	getSingleStringValueOrNullOfNamedChild(ContentItem parent, String codingSchemeDesignator, String codeValue) Retrieve the string value of the named child as defined by its ConceptName
String	getSingleStringValueOrNullOfNamedChild(String codingSchemeDesignator, String codeValue) Retrieve the string value of the named child as defined by its ConceptName
String	getValueType() Get the value type of this content item.
boolean	isLeaf() Returns true if the receiver is a leaf (has no children).
String	toString() Dump the entire tree as a String.
static String	walkTreeBuldingString(ContentItem node, String location) Dump the tree starting at the specified node as a String.

Methods inherited from class java.lang.Object

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

Field Detail

observationDateTime

protected String observationDateTime

observationUID

protected String observationUID

relationshipType

protected String relationshipType

Constructor Detail

ContentItem

protected ContentItem(ContentItem p,
                      AttributeList l)

Construct a content item for a list of attributes, and add it as a child of the specified parent.

The constructor is protected. Instances of specific types of content items should normally be created by using the ContentItemFactory.

Parameters:

p - the parent

l - the list of attributes

ContentItem

protected ContentItem(ContentItem p,
                      String relationshipType)
               throws DicomException

Construct a content item of a specified type and relationship, creating a new AttributeList, and add it as a child of the specified parent.

The constructor is protected. Instances of specific types of content items should normally be created by using the ContentItemFactory.

Parameters:

p - the parent

relationshipType - added only if not null or zero length

Throws:

DicomException - if error in DICOM encoding

ContentItem

protected ContentItem(ContentItem p,
                      String relationshipType,
                      String observationDateTime,
                      String observationUID)
               throws DicomException

Construct a content item of a specified type and relationship, creating a new AttributeList, and add it as a child of the specified parent.

The constructor is protected. Instances of specific types of content items should normally be created by using the ContentItemFactory.

Parameters:

p - the parent

relationshipType - added only if not null or zero length

observationDateTime - Observation DateTime, added only if not null or zero length

observationUID - Observation UID, added only if not null or zero length

Throws:

DicomException - if error in DICOM encoding

Method Detail

addChild

public void addChild(ContentItem child)

Add a child to this content item.

Parameters:

child - the child content item to add

addSibling

public void addSibling(ContentItem sibling)
                throws DicomException

Add a sibling to this content item (a child to the parent of this content item).

Parameters:

sibling - the sibling content item to add

Throws:

DicomException - thrown if there is no parent

children

public Enumeration children()

Returns the children of this node as an Enumeration.

Specified by:

children in interface TreeNode

Returns:

the children of this node

contentItemNameMatchesCodeValueAndCodingSchemeDesignator

public static boolean contentItemNameMatchesCodeValueAndCodingSchemeDesignator(ContentItem ci,
                                                                               String cvWanted,
                                                                               String csdWanted)

Test if the coded concept name of the content item matches the specified code value and coding scheme designator. This is more robust than checking code meaning, which may have synomyms, and there is no need to also test code meaning. Does NOT follow references.

Parameters:

ci - the content item to check

csdWanted - the coding scheme designator of the coded concept name wanted

cvWanted - the code value of the coded concept name wanted

Returns:

true if matches

contentItemNameMatchesCodeValueAndCodingSchemeDesignator

public abstract boolean contentItemNameMatchesCodeValueAndCodingSchemeDesignator(String cvWanted,
                                                                                 String csdWanted)

Test if the coded concept name of the content item matches the specified code value and coding scheme designator. This is more robust than checking code meaning, which may have synomyms, and there is no need to also test code meaning. Does NOT follow references.

Parameters:

csdWanted - the coding scheme designator wanted

cvWanted - the code value wanted

Returns:

true if matches

getAllowsChildren

public boolean getAllowsChildren()

Always returns true, since children may always be added.

Specified by:

getAllowsChildren in interface TreeNode

Returns:

always true

getAttributeList

public AttributeList getAttributeList()

Get the attribute list of this content item.

Returns:

the attribute list of this content item

getChildAt

public TreeNode getChildAt(int index)

Returns the child at the specified index.

Specified by:

getChildAt in interface TreeNode

Parameters:

index - the index of the child to be returned, numbered from 0

Returns:

the child TreeNode at the specified index

getChildCount

public int getChildCount()

Return the number of children that this node contains.

Specified by:

getChildCount in interface TreeNode

Returns:

the number of children, 0 if none

getConceptName

public CodedSequenceItem getConceptName()

Get the Concept Name.

Returns:

the Concept Name

getConceptNameAndValue

public String getConceptNameAndValue()

Get a string representation of the concept name and the value of the concept.

The exact form of the returned string is specific to the type of ContentItem.

Returns:

a String representation of the name and value, or an empty string

getConceptNameCodeMeaning

public String getConceptNameCodeMeaning()

Get the value of the code meaning of the Concept Name as a string, if present and applicable.

Returns:

the code meaning of the Concept Name, or an empty string

getConceptNameCodeValue

public String getConceptNameCodeValue()

Get the value of the code value of the Concept Name as a string, if present and applicable.

Returns:

the code value of the Concept Name, or an empty string

getConceptNameCodingSchemeDesignator

public String getConceptNameCodingSchemeDesignator()

Get the value of the coding scheme designator of the Concept Name as a string, if present and applicable.

Returns:

the coding scheme designator of the Concept Name, or an empty string

getConceptValue

public abstract String getConceptValue()

Get a string representation of the value of the concept.

The exact form of the returned string is specific to the type of ContentItem.

Returns:

a String representation of the name and value, or an empty string

getGraphicData

public float[] getGraphicData()

Get the Graphic Data of this content item, if present and applicable.

Returns:

the Graphic Data, or null

getGraphicType

public String getGraphicType()

Get the Graphic Type of this content item, if present and applicable.

Returns:

the Graphic Type, or null

getIndex

public int getIndex(TreeNode child)

Returns the index of the specified child from amongst this node's children, if present.

Specified by:

getIndex in interface TreeNode

Parameters:

child - the child to search for amongst this node's children

Returns:

the index of the child, or -1 if not present

getNamedChild

public ContentItem getNamedChild(CodedSequenceItem item)

Retrieve the named child as defined by its ConceptName The code meaning of the concept is ignored, and only the code value and coding scheme designator are compared in the search.

Parameters:

item - the coded sequence item of the concept name wanted

Returns:

the (first, if multiple) named child, or null if absent

getNamedChild

public ContentItem getNamedChild(String codingSchemeDesignator,
                                 String codeValue)

Retrieve the named child as defined by its ConceptName

Parameters:

codingSchemeDesignator - the coding scheme designator

codeValue - the code value

Returns:

the (first, if multiple) named child, or null if absent

getObservationDateTime

public String getObservationDateTime()

Get the ObservationDateTime of this content item.

Returns:

the value of the ObservationDateTime Attribute

getObservationUID

public String getObservationUID()

Get the ObservationUID of this content item.

Returns:

the value of the ObservationUID Attribute

getParent

public TreeNode getParent()

Returns the parent node of this node.

Specified by:

getParent in interface TreeNode

Returns:

the parent node, or null if the root

getParentAsContentItem

public ContentItem getParentAsContentItem()

Get the parent content item of this content item.

This method saves the caller from having to cast the value returned from TreeNode.getParent().

Returns:

the parent content item

getPositionInTreeToUseAsReferencedContentItemIdentifier

public String getPositionInTreeToUseAsReferencedContentItemIdentifier()

Get the position in the tree relative to the top parent as a String to use as a Referenced Content Item Identifier.

Returns a valid result only if the entire parent content tree back to the root has already been populated.

Returns:

the period (not backslash) delimited item references, or "1" if we have no parent

getReferencedContentItemIdentifier

public String getReferencedContentItemIdentifier()

Get the Referenced Content Item Identifier, if present.

Returns:

the period (not backslash) delimited item references, or an empty string

getReferencedContentItemIdentifierArray

public int[] getReferencedContentItemIdentifierArray()

Get the Referenced Content Item Identifier, if present.

Returns:

an array of integers representing the separated components of the Referenced Content Item Identifier, including the first (root) identifier of 1, or null if none or empty

getReferencedSOPClassUID

public String getReferencedSOPClassUID()

Get the Referenced SOP Class UID of this content item, if present and applicable.

Returns:

the Referenced SOP Class UID, or null

getReferencedSOPInstanceUID

public String getReferencedSOPInstanceUID()

Get the Referenced SOP Instance UID of this content item, if present and applicable.

Returns:

the Referenced SOP Instance UID, or null

getRelationshipType

public String getRelationshipType()

Get the relationship type of this content item.

Returns:

the relationship type (the string used in the DICOM standard in the Relationship Type attribute)

getSingleStringValueOrNull

public String getSingleStringValueOrNull()

Retrieve the string value of self

Returns:

the value , or null if absent

getSingleStringValueOrNullOfNamedChild

public static String getSingleStringValueOrNullOfNamedChild(ContentItem parent,
                                                            String codingSchemeDesignator,
                                                            String codeValue)

Retrieve the string value of the named child as defined by its ConceptName

Parameters:

parent - the parent

codingSchemeDesignator - the coding scheme designator

codeValue - the code value

Returns:

the value of the (first, if multiple) named child, or null if absent

getSingleStringValueOrNullOfNamedChild

public String getSingleStringValueOrNullOfNamedChild(String codingSchemeDesignator,
                                                     String codeValue)

Retrieve the string value of the named child as defined by its ConceptName

Parameters:

codingSchemeDesignator - the coding scheme designator

codeValue - the code value

Returns:

the value of the (first, if multiple) named child, or null if absent

getValueType

public String getValueType()

Get the value type of this content item.

Returns:

the value type (the string used in the DICOM standard in the Value Type attribute)

isLeaf

public boolean isLeaf()

Returns true if the receiver is a leaf (has no children).

Specified by:

isLeaf in interface TreeNode

Returns:

true if the receiver is a leaf

toString

public String toString()

Dump the entire tree as a String.

Overrides:

toString in class Object

Returns:

a multi-line String representing the tree

walkTreeBuldingString

public static String walkTreeBuldingString(ContentItem node,
                                           String location)

Dump the tree starting at the specified node as a String.

Parameters:

node -

location - the dotted numeric string describing the location of the starting node

Returns:

a multi-line String representing the tree fragment