com.pixelmed.dicom

Class ContentItemWithReference

java.lang.Object

com.pixelmed.dicom.ContentItem

com.pixelmed.dicom.ContentItemWithReference

All Implemented Interfaces:

TreeNode

public class ContentItemWithReference
extends ContentItem

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:

ContentItem, ContentItemFactory, ContentItemWithValue, StructuredReport, StructuredReportBrowser

Field Summary

Fields

Modifier and Type	Field and Description
protected String	referencedContentItemIdentifier

Fields inherited from class com.pixelmed.dicom.ContentItem

observationDateTime, observationUID, relationshipType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContentItemWithReference(ContentItem p, AttributeList l) Construct a content item for a list of attributes, and add it as a child of the specified parent.
	ContentItemWithReference(ContentItem p, String relationshipType, String referencedContentItemIdentifier) 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
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.
String	getConceptValue() Get a string representation of the value of the concept.
String	getReferencedContentItemIdentifier() Get the Referenced Content Item Identifier, if present.
int[]	getReferencedContentItemIdentifierArray() Get the Referenced Content Item Identifier, if present.
String	toString() Get a human-readable string representation of the content item.

Methods inherited from class com.pixelmed.dicom.ContentItem

addChild, addSibling, children, contentItemNameMatchesCodeValueAndCodingSchemeDesignator, getAllowsChildren, getAttributeList, getChildAt, getChildCount, getConceptName, getConceptNameAndValue, getConceptNameCodeMeaning, getConceptNameCodeValue, getConceptNameCodingSchemeDesignator, getGraphicData, getGraphicType, getIndex, getNamedChild, getNamedChild, getObservationDateTime, getObservationUID, getParent, getParentAsContentItem, getPositionInTreeToUseAsReferencedContentItemIdentifier, getReferencedSOPClassUID, getReferencedSOPInstanceUID, getRelationshipType, getSingleStringValueOrNull, getSingleStringValueOrNullOfNamedChild, getSingleStringValueOrNullOfNamedChild, getValueType, isLeaf, walkTreeBuldingString

Methods inherited from class java.lang.Object

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

Field Detail

referencedContentItemIdentifier

protected String referencedContentItemIdentifier

Constructor Detail

ContentItemWithReference

protected ContentItemWithReference(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

ContentItemWithReference

public ContentItemWithReference(ContentItem p,
                                String relationshipType,
                                String referencedContentItemIdentifier)
                         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.

Parameters:

p - the parent

relationshipType - added only if not null or zero length

referencedContentItemIdentifier - identifier of reference content item

Throws:

DicomException - if error in DICOM encoding

Method Detail

contentItemNameMatchesCodeValueAndCodingSchemeDesignator

public boolean contentItemNameMatchesCodeValueAndCodingSchemeDesignator(String cvWanted,
                                                                        String csdWanted)

Description copied from class: ContentItem

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.

Specified by:

contentItemNameMatchesCodeValueAndCodingSchemeDesignator in class ContentItem

Parameters:

cvWanted - the code value wanted

csdWanted - the coding scheme designator wanted

Returns:

true if matches

getConceptValue

public String getConceptValue()

Get a string representation of the value of the concept.

Always returns an empty string for a ContentItemWithReference.

Specified by:

getConceptValue in class ContentItem

Returns:

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

getReferencedContentItemIdentifier

public String getReferencedContentItemIdentifier()

Get the Referenced Content Item Identifier, if present.

Overrides:

getReferencedContentItemIdentifier in class ContentItem

Returns:

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

getReferencedContentItemIdentifierArray

public int[] getReferencedContentItemIdentifierArray()

Get the Referenced Content Item Identifier, if present.

Overrides:

getReferencedContentItemIdentifierArray in class ContentItem

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

toString

public String toString()

Get a human-readable string representation of the content item.

Overrides:

toString in class ContentItem

Returns:

the string representation of the content item