cdac.medinfo.sdk.dcm30_04.baselibs

Class ContentItemMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.ContentItemMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class ContentItemMacro
extends Macro

A content item is a flexible means of encoding attribute identifiers and attribute values using the Code Sequence Macro for coded terminology defined by a coding scheme.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContentItemMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
ContentItemMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
ContentItemMacro(IItem objItem) This constructor constructs a Macro with the specified Item
ContentItemMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
ConceptCodeSequence	getConceptCodeSequence() Retrieves pre-initialized object of Concept Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
ConceptNameCodeSequence	getConceptNameCodeSequence() Retrieves pre-initialized object of Concept Name Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
java.lang.String	getDate() Retrieves Date.
java.lang.String	getDateTime() Retrieves DateTime.
double[]	getFloatingPointValue() Retrieves the Floating Point Value.
MeasurementUnitsCodeSequence	getMeasurementUnitsCodeSequence() Retrieves pre-initialized object of Measurement Units Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
java.lang.String[]	getNumericValue() Retrieves Numeric Value.
java.lang.String	getPersonName() Retrieves Person Name.
long[]	getRationalDenominatorValue() Retrieves Referenced Content Item Identifier.
java.lang.Long[]	getRationalNumeratorValue() Retrieves the Rational Numerator Value.
short[]	getReferencedFrameNumber() Retrieves Referenced Frame Number.
short[]	getReferencedSegmentNumber() Retrieves Referenced Segment Number.
ReferencedSOPSequence	getReferencedSOPSequence() Retrieves pre-initialized object of Referenced SOP Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
java.lang.String	getTextValue() Retrieves the value of the Content Item.
java.lang.String	getTime() Retrieves Time.
java.lang.String	getUID() Retrieves a UID.
java.lang.String	getValueType() Return Value Type.
void	setDate(java.lang.String strDate) Sets Date.
void	setDateTime(java.lang.String strDateTime) Sets Date and Time.
void	setFloatingPointValue(double[] dblArrFloatingPointValue) Sets the Floating Point Value.
void	setNumericValue(java.lang.String[] strSliceThickness) Sets Numeric Value.
void	setPersonName(java.lang.String strPersonName) Sets Person Name.
void	setRationalDenominatorValue(long[] lArrRationalDenominatorValue) Sets Rational Denominator Value.
void	setRationalNumeratorValue(java.lang.Long[] lArrRationalNumeratorValue) Sets Rational Numerator Value.
void	setReferencedFrameNumber(short[] arrShReferencedFrameNumber) Sets Referenced Frame Number.
void	setReferencedSegmentNumber(short[] arrShReferencedSegmentNumber) Sets Referenced Segment Number.
void	setTextValue(java.lang.String strTextValue) Sets the value of the Content Item.
void	setTime(java.lang.String strTime) Sets Time.
void	setUID(java.lang.String strUID) Sets a UID.
void	setValueType(EnumValueType enumValueType) Sets type of Value.
boolean	validate() Validates all the attributes in CodeSequenceMacro that are present in the DataSet
boolean	validate(IDataSet objIDataSet) Validates all the attributes in Content Macro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in Content Item Macro that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Macro

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContentItemMacro

public ContentItemMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

ContentItemMacro

public ContentItemMacro(IDataSet objDataSet,
                IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

ContentItemMacro

public ContentItemMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

ContentItemMacro

public ContentItemMacro(IItem objItem,
                IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in CodeSequenceMacro that are present in the DataSet

Returns:

int - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public boolean validate(IDataSet objIDataSet)
                 throws InvalidMacroException

Validates all the attributes in Content Macro that are present in the DataSet

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

Validates all the attributes in Content Item Macro that are present in the DataSet

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

setValueType

public void setValueType(EnumValueType enumValueType)

Sets type of Value. The type of the value encoded in the Content Item. Defined Terms: 1) DATE. 2) TIME. 3) DATETIME. 4) PNAME. 5) UIDREF. 6) TEXT. 7) CODE. 8) NUMERIC. 9) COMPOSITE. 10) IMAGE.

Parameters:

enumValueType - enum value of ValueType.

getValueType

public java.lang.String getValueType()

Return Value Type. The type of the value encoded in the Content Item.

Returns:

String - value of ValueType.

getConceptNameCodeSequence

public ConceptNameCodeSequence getConceptNameCodeSequence()

Retrieves pre-initialized object of Concept Name Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

ConceptNameCodeSequence - instance of ConceptNameCodeSequence.

setDateTime

public void setDateTime(java.lang.String strDateTime)

Sets Date and Time. DateTime value for the Content Item.

Parameters:

strDateTime - String value of DateTime

getDateTime

public java.lang.String getDateTime()

Retrieves DateTime. DateTime value for the Content Item.

Returns:

String - value of DateTime

setDate

public void setDate(java.lang.String strDate)

Sets Date. Date value for the Content Item.

Parameters:

strDate - String value of Date.

getDate

public java.lang.String getDate()

Retrieves Date. Date value for the Content Item.

Returns:

String - value of Date.

setTime

public void setTime(java.lang.String strTime)

Sets Time. Time value for the Content Item.

Parameters:

strTime - String array of Time.

getTime

public java.lang.String getTime()

Retrieves Time. Time value for the Content Item.

Returns:

String - value of Time.

setPersonName

public void setPersonName(java.lang.String strPersonName)

Sets Person Name. Person name value for the Content Item.

Parameters:

strPersonName - String Person Name.

getPersonName

public java.lang.String getPersonName()

Retrieves Person Name. Person name value for the Content Item.

Returns:

String - Name of the Person.

setUID

public void setUID(java.lang.String strUID)

Sets a UID. UID value for the Content Item.

Parameters:

strUID - String value of UID.

getUID

public java.lang.String getUID()

Retrieves a UID. UID value for the Content Item.

Returns:

String - value of UID.

setTextValue

public void setTextValue(java.lang.String strTextValue)

Sets the value of the Content Item.

Parameters:

strTextValue - String value of Content Item.

getTextValue

public java.lang.String getTextValue()

Retrieves the value of the Content Item.

Returns:

String - value of the value of the Content Item.

getConceptCodeSequence

public ConceptCodeSequence getConceptCodeSequence()

Retrieves pre-initialized object of Concept Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

PrimaryFluenceModeSequence - instance of PrimaryFluenceModeSequence.

setNumericValue

public void setNumericValue(java.lang.String[] strSliceThickness)

Sets Numeric Value. Numeric value for the Content Item.

Parameters:

strSliceThickness - String value of Numeric Value.

getNumericValue

public java.lang.String[] getNumericValue()

Retrieves Numeric Value. Numeric value for the Content Item.

Returns:

String - value of Numeric Value.

setFloatingPointValue

public void setFloatingPointValue(double[] dblArrFloatingPointValue)

Sets the Floating Point Value.

Parameters:

dblArrFloatingPointValue - Double value of FloatingPointValue

getFloatingPointValue

public double[] getFloatingPointValue()

Retrieves the Floating Point Value.

Returns:

double - double value of Floating Point Value

setRationalNumeratorValue

public void setRationalNumeratorValue(java.lang.Long[] lArrRationalNumeratorValue)

Sets Rational Numerator Value.

Parameters:

lArrRationalNumeratorValue - Long array of Rational Numerator Value.

getRationalNumeratorValue

public java.lang.Long[] getRationalNumeratorValue()

Retrieves the Rational Numerator Value.

Returns:

Long[] - Long array of Rational Numerator Value.

setRationalDenominatorValue

public void setRationalDenominatorValue(long[] lArrRationalDenominatorValue)

Sets Rational Denominator Value.

Parameters:

lArrRationalDenominatorValue - Long value of Referenced Content Item Identifier

getRationalDenominatorValue

public long[] getRationalDenominatorValue()

Retrieves Referenced Content Item Identifier.

Returns:

long[] - long value of Referenced Content Item Identifier.

getMeasurementUnitsCodeSequence

public MeasurementUnitsCodeSequence getMeasurementUnitsCodeSequence()

Retrieves pre-initialized object of Measurement Units Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

MeasurementUnitsCodeSequence - instance of MeasurementUnitsCodeSequence.

getReferencedSOPSequence

public ReferencedSOPSequence getReferencedSOPSequence()

Retrieves pre-initialized object of Referenced SOP Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

ReferencedSOPSequence - instance of ReferencedSOPSequence.

setReferencedFrameNumber

public void setReferencedFrameNumber(short[] arrShReferencedFrameNumber)

Sets Referenced Frame Number.

Parameters:

arrShReferencedFrameNumber -

getReferencedFrameNumber

public short[] getReferencedFrameNumber()

Retrieves Referenced Frame Number.

Returns:

short Array - Referenced Frame Number.

setReferencedSegmentNumber

public void setReferencedSegmentNumber(short[] arrShReferencedSegmentNumber)

Sets Referenced Segment Number.

Parameters:

arrShReferencedSegmentNumber - - Referenced Segment Number

getReferencedSegmentNumber

public short[] getReferencedSegmentNumber()

Retrieves Referenced Segment Number.

Returns:

short Array - Referenced Segment Number.