cdac.medinfo.sdk.dcm30_04.baselibs

Class ExplicitDE

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DataElement

cdac.medinfo.sdk.dcm30_04.baselibs.ExplicitDE

All Implemented Interfaces:

IDataElement, java.io.Serializable

public class ExplicitDE
extends DataElement

This Class represent DATA ELEMENT WITH EXPLICIT VR. A Data Element with explicit VR contains Tag, VR, Length and Value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExplicitDE() Creates Explicit Data Element with Default Dictionary Reader & Little Endian Explicit Transfer syntax.
ExplicitDE(IDictionaryReader objIDictReader) Creates empty Explicit Data Element with specified dictionary reader and Little Endian Explicit Transfer syntax.
ExplicitDE(int iGroupNumber, int iElementNumber, DicomValue objDicomValue, ITransferSyntax objITransferSyntax, IDictionaryReader objIDictReader) Creates Explicit DataElement based on the GroupNumber, ElementNumber, VR Type , Dicom Data , Transfer Syntax and Dictionary Reader.
ExplicitDE(int iGroupNumber, int iElementNumber, int iVRType, java.lang.Object objValue) Creates Explicit DataElement based on the GroupNumber, ElementNumber, VR Type and value.
ExplicitDE(int iGroupNumber, int iElementNumber, int iVRType, java.lang.Object objValue, IDictionaryReader objIDictReader) Creates Explicit DataElement based on the GroupNumber, ElementNumber, VR Type, Value and Dictionary Reader.
ExplicitDE(int iGroupNumber, int iElementNumber, int iVRType, java.lang.Object objValue, ITransferSyntax objITransferSyntax) Creates Explicit Data Element based on GroupNumber, ElementNumber, VR Type, Value and TransferSyntax.
ExplicitDE(int iGroupNumber, int iElementNumber, int iVRType, java.lang.Object objValue, ITransferSyntax objITransferSyntax, IDictionaryReader objIDictReader) Create a DataElement containing sequence in which case the Transfersyntax and Dictionary Reader needs to be specified from outside.
ExplicitDE(ITransferSyntax objITransferSyntax) Creates empty Explicit Data Element with specified Transfer Syntax.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object objTempObject) This method checks for equality of two data elements.
int	getDataElementLength() Retrieves the length of the DataElement
int	getIVRType() Retrieves the value representation type of the Dicom Data
int	parse(IDicomStream objIDicomStream) This method parses the data element with explicitDE structure specified in documentation Note : It could throw OutOfMemoryException if length exceeds from allowed Heap Space.
int	serialize(IDicomStream objIDicomStream) Serializes the DataElement onto the stream provided
void	setDictionaryReader(IDictionaryReader objIDictReader) Sets the Dictionary Reader.
void	setIVRType(int iVRType) sets the Value Representation type into the DicomValue

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

clone, dumpDICOMInfo, getDicomValue, getDictionaryReader, getTag, getTransferSyntax, getValue, getValueLength, getValueMultiplicity, setDicomValue, setTag, setTransferSyntax, setValueMultiplicity, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ExplicitDE

public ExplicitDE()

Creates Explicit Data Element with Default Dictionary Reader & Little Endian Explicit Transfer syntax.

ExplicitDE

public ExplicitDE(ITransferSyntax objITransferSyntax)

Creates empty Explicit Data Element with specified Transfer Syntax.

Parameters:

objITransferSyntax - value of Transfer Syntax.

ExplicitDE

public ExplicitDE(IDictionaryReader objIDictReader)

Creates empty Explicit Data Element with specified dictionary reader and Little Endian Explicit Transfer syntax.

Parameters:

objIDictReader - Dictionary Reader instance.

ExplicitDE

public ExplicitDE(int iGroupNumber,
          int iElementNumber,
          DicomValue objDicomValue,
          ITransferSyntax objITransferSyntax,
          IDictionaryReader objIDictReader)
           throws InvalidDataElementException

Creates Explicit DataElement based on the GroupNumber, ElementNumber, VR Type , Dicom Data , Transfer Syntax and Dictionary Reader. The Dicom data should be populated.

Parameters:

iGroupNumber - GroupNumber from the Tag identifying this DataElement.

iElementNumber - ElementNumber from the Tag identifying this DataElement.

iVRType - Value Representation Type specified in @see DicomConstants.

objDicomValue - Populated Dicom Data to be set in Explicit Data Element.

objITransferSyntax - value of Transfer Syntax.

objIDictReader - Dictionary Reader instance.

Throws:

InvalidDataElementException - thrown when creation of Data Element fails.

ExplicitDE

public ExplicitDE(int iGroupNumber,
          int iElementNumber,
          int iVRType,
          java.lang.Object objValue)
           throws InvalidDataElementException

Creates Explicit DataElement based on the GroupNumber, ElementNumber, VR Type and value. The Transfer Syntax would be considered as Little Endian Explicit and the default dictionary reader will.

Parameters:

iGroupNumber - GroupNumber from the Tag identifying this DataElement.

iElementNumber - ElementNumber from the Tag identifying this DataElement.

iVRType - Value Representation Type specified in @see DicomConstants.

objValue - value of the DataElement.

Throws:

InvalidDataElementException - thrown when creation of Data Element fails.

ExplicitDE

public ExplicitDE(int iGroupNumber,
          int iElementNumber,
          int iVRType,
          java.lang.Object objValue,
          IDictionaryReader objIDictReader)
           throws InvalidDataElementException

Creates Explicit DataElement based on the GroupNumber, ElementNumber, VR Type, Value and Dictionary Reader. The Transfer Syntax would be specified implicitly as LittleEndianExplicit.

Parameters:

iGroupNumber - GroupNumber from the Tag identifying this DataElement.

iElementNumber - ElementNumber from the the identifying this DataElement.

iVRType - Value Representation Type specified in @see DicomConstants.

objValue - Value of the DataElement.

objIDictReader - instance of Dictionary Reader

Throws:

InvalidDataElementException - thrown when creation of Data Element fails.

ExplicitDE

public ExplicitDE(int iGroupNumber,
          int iElementNumber,
          int iVRType,
          java.lang.Object objValue,
          ITransferSyntax objITransferSyntax)
           throws InvalidDataElementException

Creates Explicit Data Element based on GroupNumber, ElementNumber, VR Type, Value and TransferSyntax. The default Data Dictionary will be used.

Parameters:

iGroupNumber - GroupNumber from the Tag identifying this DataElement.

iElementNumber - ElementNumber from the Tah identifying this DataElement.

iVRType - Value Representation Type specified in @see DicomConstants.

objValue - value of the DataElement.

objITransferSyntax - value of Transfer Syntax.

Throws:

InvalidDataElementException - thrown when creation of Data Element fails.

ExplicitDE

public ExplicitDE(int iGroupNumber,
          int iElementNumber,
          int iVRType,
          java.lang.Object objValue,
          ITransferSyntax objITransferSyntax,
          IDictionaryReader objIDictReader)
           throws InvalidDataElementException

Create a DataElement containing sequence in which case the Transfersyntax and Dictionary Reader needs to be specified from outside.

Parameters:

iGroupNumber - GroupNumber from the Tag identifying this DataElement

iElementNumber - ElementNumber from the the identifying this DataElement

iVRType - Value Representation Type specified in @see DicomConstants

objValue - value of the DataElement

objITransferSyntax - TransferSyntax specified by the DICOM Standard.

objIDictReader - instance of Dictionary Reader

Throws:

InvalidDataElementException - thrown when creation of Data Element fails.

Method Detail

parse

public int parse(IDicomStream objIDicomStream)
          throws InvalidDataElementException,
                 java.io.IOException

This method parses the data element with explicitDE structure specified in documentation Note : It could throw OutOfMemoryException if length exceeds from allowed Heap Space.

Specified by:

parse in interface IDataElement

Specified by:

parse in class DataElement

Parameters:

objIDicomStream - stream from which the DataElement is to be parsed and populated

Returns:

integer - status indicating success/failure of parsing

Throws:

InvalidDataElementException - If Data Element fails to satisfy Validation Criteria.

java.io.IOException - If Input/Output operation fails.

See Also:

com.cdac.dcmlibs.baselibs.DataElement#parse(com.cdac.dcmlibs.commoninterface.IDicomStream)

serialize

public int serialize(IDicomStream objIDicomStream)
              throws java.io.IOException

Serializes the DataElement onto the stream provided

Specified by:

serialize in interface IDataElement

Specified by:

serialize in class DataElement

Parameters:

objIDicomStream - stream from which the DataElement is to be parsed and populated

Returns:

integer status indicating success/failure of parsing

Throws:

java.io.IOException - Signals that an I/O exception of some sort has occurred.

getIVRType

public int getIVRType()

Retrieves the value representation type of the Dicom Data

Returns:

integer - returns integer specifying the Value Representation type.

See Also:

DicomConstants

setIVRType

public void setIVRType(int iVRType)

sets the Value Representation type into the DicomValue

Parameters:

iVRType - specifies the Value Representation type

getDataElementLength

public int getDataElementLength()

Retrieves the length of the DataElement

Specified by:

getDataElementLength in interface IDataElement

Specified by:

getDataElementLength in class DataElement

Returns:

integer - returns the length of the DataElement

setDictionaryReader

public void setDictionaryReader(IDictionaryReader objIDictReader)

Sets the Dictionary Reader. Dictionary Reader is used to verify the Value Representation of a Data Element while creating a Data Element.

Overrides:

setDictionaryReader in class DataElement

Parameters:

objIDictReader - DictionaryReader to read from the Dictionary.

equals

public boolean equals(java.lang.Object objTempObject)

This method checks for equality of two data elements.

Specified by:

equals in interface IDataElement

Overrides:

equals in class DataElement

Parameters:

objTempObject - Data Element whose equality has to be checked with instance data element.

Returns:

boolean - true if the data element passed as parameter and instance data element are equal and false if data elements passed as parameter and instance data element are not equal.