cdac.medinfo.sdk.dcm30_04.baselibs

Class DataElement

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DataElement

All Implemented Interfaces:

IDataElement, java.io.Serializable

Direct Known Subclasses:

ExplicitDE, ImageElement, ImplicitDE

public abstract class DataElement
extends java.lang.Object
implements IDataElement

The class is used for entering data, user/stream has to create DataElement object and specify details. Once the DataSet object is filled, then user will call fillModel() method which will populate the model.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Create similar object of this class.
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the contents of Data Element in readable form to the specified stream.
boolean	equals(java.lang.Object objTempObject) This method checks for equality of two data elements.
abstract int	getDataElementLength() The implementation of this method retrieves the length of DataElement.
IDicomValue	getDicomValue() Returns the value part of the Data Element.
IDictionaryReader	getDictionaryReader() This method returns the dictionaryreader set in the Implicit DataElement
ITag	getTag() Returns the Tag part of the Data Element.
ITransferSyntax	getTransferSyntax() This method returns the TransferSyntax set in the DataElement
java.lang.Object	getValue() This function will retrieve the value of dicom data of the Data Element.
int	getValueLength() Retrieves value length of data element
int	getValueMultiplicity() Retrieves the value multiplicity of the value.
abstract int	parse(IDicomStream objIDicomStream) The implementation of this method parses the Data Element from the given Stream.
abstract int	serialize(IDicomStream objIDicomStream) The implementation of this method serializes the Data Element from the given Stream
void	setDicomValue(IDicomValue objDicomValue) sets the DicomValue as a value in the DataElement
void	setDictionaryReader(IDictionaryReader objIDictionaryReader) Sets the Dictionary Reader.
void	setTag(int iGroupNumber, int iElementNumber) Sets the Tag in Data Element.
void	setTransferSyntax(ITransferSyntax objITransferSyntax) Sets the Transfer Syntax.
void	setValueMultiplicity(int iVM) Sets the value multiplicity of the value in tha DataElement
boolean	validate() Validates the DataElement and throws exception on validation Failure.

Methods inherited from class java.lang.Object

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

Method Detail

getValueLength

public int getValueLength()

Retrieves value length of data element

Specified by:

getValueLength in interface IDataElement

Returns:

int - value length of data element

getValueMultiplicity

public int getValueMultiplicity()

Retrieves the value multiplicity of the value.

Specified by:

getValueMultiplicity in interface IDataElement

Returns:

integer - returns the value multiplicity of the value in DataElement

setValueMultiplicity

public void setValueMultiplicity(int iVM)

Sets the value multiplicity of the value in tha DataElement

Specified by:

setValueMultiplicity in interface IDataElement

Parameters:

iVM - integer value multiplicity of the value

setTag

public void setTag(int iGroupNumber,
          int iElementNumber)

Sets the Tag in Data Element.

Specified by:

setTag in interface IDataElement

Parameters:

iGroupNumber - Integer Value of Group Number.

iElementNumber - Integer Value of Element Number.

getTag

public ITag getTag()

Returns the Tag part of the Data Element.

Specified by:

getTag in interface IDataElement

Returns:

ITag - Tag containing Group Number and Element Number.

getDicomValue

public IDicomValue getDicomValue()

Returns the value part of the Data Element.

Specified by:

getDicomValue in interface IDataElement

Returns:

IDicomValue - instance containing the value of the Data Element.

setDicomValue

public void setDicomValue(IDicomValue objDicomValue)

sets the DicomValue as a value in the DataElement

Specified by:

setDicomValue in interface IDataElement

Parameters:

objDicomValue - object of DicomValue representing the value of DataElement

setTransferSyntax

public void setTransferSyntax(ITransferSyntax objITransferSyntax)

Sets the Transfer Syntax.

Specified by:

setTransferSyntax in interface IDataElement

Parameters:

objITransferSyntax - value of Transfer Syntax.

setDictionaryReader

public void setDictionaryReader(IDictionaryReader objIDictionaryReader)

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

Parameters:

objIDictionaryReader - DictionaryReader to read from the Dictionary.

getDictionaryReader

public IDictionaryReader getDictionaryReader()

This method returns the dictionaryreader set in the Implicit DataElement

Returns:

objIDictionaryReader - object of dictionary reader set in the Implicit DataElement

getTransferSyntax

public ITransferSyntax getTransferSyntax()

This method returns the TransferSyntax set in the DataElement

Specified by:

getTransferSyntax in interface IDataElement

Returns:

objITransferSyntax - TransferSyntax set in the DataElement

parse

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

The implementation of this method parses the Data Element from the given Stream.

Specified by:

parse in interface IDataElement

Parameters:

objIDicomStream - Stream on which the DICOM data is available.

Returns:

int - shows status as success or failure.

Throws:

InvalidDataElementException - If Data Element fails to satisfy Validation Criteria.

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

serialize

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

The implementation of this method serializes the Data Element from the given Stream

Specified by:

serialize in interface IDataElement

Parameters:

objIDicomStream - Stream on which the DICOM data is available

Returns:

int - shows status as success or failure.

Throws:

InvalidDataElementException - If Data Element fails to satisfy Validation Criteria.

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

getDataElementLength

public abstract int getDataElementLength()

The implementation of this method retrieves the length of DataElement.

Specified by:

getDataElementLength in interface IDataElement

Returns:

int - Integer value of length.

validate

public boolean validate()
                 throws InvalidDataElementException

Validates the DataElement and throws exception on validation Failure.

Specified by:

validate in interface IDataElement

Returns:

boolean - Result Status, True : Success, False : Failure

Throws:

InvalidDataElementException - If Data Element fails to satisfy Validation Criteria.

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 java.lang.Object

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.

getValue

public java.lang.Object getValue()

This function will retrieve the value of dicom data of the Data Element.

Specified by:

getValue in interface IDataElement

Returns:

Object - value of dicom data of the Data Element.

clone

public java.lang.Object clone()

Create similar object of this class. This does the deep copy and create a new instance of this class nad return it.

Specified by:

clone in interface IDataElement

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance.

dumpDICOMInfo

public void dumpDICOMInfo(IDicomStream objIDicomStream)
                   throws java.io.IOException

Dumps the contents of Data Element in readable form to the specified stream. Contents such as VR, Value Length, and Value are dumped.

Specified by:

dumpDICOMInfo in interface IDataElement

Parameters:

objIDicomStream - - the Stream on which the Data is to be written.

Throws:

java.io.IOException - - Exception is thrown indicating runtime failure of writing operation.