com.pixelmed.dicom

Class DicomDirectoryRecord

java.lang.Object

com.pixelmed.dicom.DicomDirectoryRecord

All Implemented Interfaces:

Comparable, TreeNode

Direct Known Subclasses:

DicomDirectoryRecordFactory.ConcatenationDirectoryRecord, DicomDirectoryRecordFactory.EncapsulatedDocumentDirectoryRecord, DicomDirectoryRecordFactory.FiducialDirectoryRecord, DicomDirectoryRecordFactory.HL7StructuredDocumentDirectoryRecord, DicomDirectoryRecordFactory.ImageDirectoryRecord, DicomDirectoryRecordFactory.KODocumentDirectoryRecord, DicomDirectoryRecordFactory.PatientDirectoryRecord, DicomDirectoryRecordFactory.PresentationStateDirectoryRecord, DicomDirectoryRecordFactory.RawDataDirectoryRecord, DicomDirectoryRecordFactory.RealWorldValueMappingDirectoryRecord, DicomDirectoryRecordFactory.RegistrationDirectoryRecord, DicomDirectoryRecordFactory.RTDoseDirectoryRecord, DicomDirectoryRecordFactory.RTPlanDirectoryRecord, DicomDirectoryRecordFactory.RTStructureSetDirectoryRecord, DicomDirectoryRecordFactory.RTTreatmentRecordDirectoryRecord, DicomDirectoryRecordFactory.SeriesDirectoryRecord, DicomDirectoryRecordFactory.SpectroscopyDirectoryRecord, DicomDirectoryRecordFactory.SRDocumentDirectoryRecord, DicomDirectoryRecordFactory.StereometricRelationshipDirectoryRecord, DicomDirectoryRecordFactory.StudyDirectoryRecord, DicomDirectoryRecordFactory.TopDirectoryRecord, DicomDirectoryRecordFactory.UnrecognizedDirectoryRecord, DicomDirectoryRecordFactory.WaveformDirectoryRecord

public abstract class DicomDirectoryRecord
extends Object
implements Comparable, TreeNode

Field Summary

Fields

Modifier and Type	Field and Description
protected int	integerValue
protected String	stringValue
protected String	uid

Constructor Summary

Constructors

Constructor and Description
DicomDirectoryRecord(DicomDirectoryRecord p, AttributeList l)

Method Summary

Modifier and Type	Method and Description
void	addChild(DicomDirectoryRecord child)
void	addSibling(DicomDirectoryRecord sibling)
Enumeration	children()
int	compareTo(Object o)
protected int	compareToByIntegerValue(DicomDirectoryRecord record, boolean mustBeSameObjectToBeEqual) Compares this object with the specified directory record for order based on integer value.
protected int	compareToByStringValue(DicomDirectoryRecord record, boolean mustBeSameObjectToBeEqual) Compares this object with the specified directory record for order based on string value.
boolean	equals(Object o)
boolean	getAllowsChildren()
AttributeList	getAttributeList()
TreeNode	getChildAt(int index)
int	getChildCount()
int	getIndex(TreeNode child)
protected int	getIntegerValue()
TreeNode	getParent()
protected String	getStringValue()
protected String	getUIDForComparison()
boolean	isLeaf()
protected abstract void	makeIntegerValue() Make the value that will be retured on a call to getIntegerValue().
protected abstract void	makeStringValue() Make the value that will be retured on a call to getStringValue().
void	removeChild(DicomDirectoryRecord child)
void	setParent(DicomDirectoryRecord parent) Set the parent node of this node.

Methods inherited from class java.lang.Object

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

Field Detail

integerValue

protected int integerValue

stringValue

protected String stringValue

uid

protected String uid

Constructor Detail

DicomDirectoryRecord

public DicomDirectoryRecord(DicomDirectoryRecord p,
                            AttributeList l)

Parameters:

p - directory record

l - list of attributes

Method Detail

addChild

public void addChild(DicomDirectoryRecord child)

Parameters:

child - child directory record to add

addSibling

public void addSibling(DicomDirectoryRecord sibling)
                throws DicomException

Parameters:

sibling - sibling to add

Throws:

DicomException - if no parent

children

public Enumeration children()

Specified by:

children in interface TreeNode

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

compareToByIntegerValue

protected final int compareToByIntegerValue(DicomDirectoryRecord record,
                                            boolean mustBeSameObjectToBeEqual)

Compares this object with the specified directory record for order based on integer value.

Considers whether same record type, same integer value, and if so orders by string value, then by UID.

Parameters:

record - the directory record to compare with

mustBeSameObjectToBeEqual - if true requires them to be the same Java object, not just the same UID

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the directory record.

compareToByStringValue

protected final int compareToByStringValue(DicomDirectoryRecord record,
                                           boolean mustBeSameObjectToBeEqual)

Compares this object with the specified directory record for order based on string value.

Considers whether same record type, same string value, and if so, orders by UID.

Parameters:

record - the directory record to compare with

mustBeSameObjectToBeEqual - if true requires them to be the same Java object, not just the same UID

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the directory record.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

getAttributeList

public AttributeList getAttributeList()

Returns:

a list of attributes for this directory record

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

getIndex

public int getIndex(TreeNode child)

Specified by:

getIndex in interface TreeNode

getIntegerValue

protected int getIntegerValue()

Returns:

an integer describing this directory record derived from an appropriate number for the entity that the record represents

getParent

public TreeNode getParent()

Specified by:

getParent in interface TreeNode

getStringValue

protected String getStringValue()

Returns:

a String describing this directory record containing identifiers, dates, etc.

getUIDForComparison

protected final String getUIDForComparison()

Returns:

the uid for the entity that the directory record represents

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface TreeNode

makeIntegerValue

protected abstract void makeIntegerValue()

Make the value that will be retured on a call to getIntegerValue().

makeStringValue

protected abstract void makeStringValue()

Make the value that will be retured on a call to getStringValue().

removeChild

public void removeChild(DicomDirectoryRecord child)

Parameters:

child - child directory record to remove

setParent

public void setParent(DicomDirectoryRecord parent)

Set the parent node of this node.

Parameters:

parent - parent directory record