cdac.medinfo.sdk.dcm30_04.commoninterface

Interface IDataElement

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DataElement, ExplicitDE, ImageElement, ImplicitDE

public interface IDataElement
extends java.io.Serializable

This interface corresponds to needs to be implemented by all classes which implements functioning of DataElement. The methods in this interface can be used to obtain information about DataElement.

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) Check for the equality of two objects.
int	getDataElementLength() Retrieves the length of DataElement.
IDicomValue	getDicomValue() Retrieves the value part of the Data Element.
ITag	getTag() Retrieves the Tag part of the Data Element.
ITransferSyntax	getTransferSyntax() Retrieves the TransferSyntax set in the DataElement object.
java.lang.Object	getValue() This function will retrieve the value of dicom data of the Data Element.
int	getValueLength() Retrieves the length of value for a DataElement.
int	getValueMultiplicity() Retrieves the value multiplicity of the value in DataElement
int	parse(IDicomStream objIDicomStream) Parses the Data Element from the given Stream.
int	serialize(IDicomStream objIDicomStream) Serializes the Data Element from the given Stream
void	setDicomValue(IDicomValue objIDicomValue) Sets the DicomValue as a value in the DataElement
void	setTag(int iGroupNumber, int iElementNumber) Sets the GroupNumber and ElementNumber of the Data Element.
void	setTransferSyntax(ITransferSyntax objITransferSyntax) Sets the transfer syntax in the DataElement object.
void	setValueMultiplicity(int iVM) Sets the value multiplicity of the value of DataElement
boolean	validate() Validates the DataElemnt according to the DICOM Rules

Method Detail

serialize

int serialize(IDicomStream objIDicomStream)
              throws InvalidDataTypeException,
                     java.io.IOException

Serializes the Data Element from the given Stream

Parameters:

objIDicomStream - Stream on which the DICOM data is available

Returns:

int - shows status as success or failure.

Throws:

InvalidDataTypeException - If DataType validation fails.

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

parse

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

Parses the Data Element from the given Stream.

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.

getValueLength

int getValueLength()

Retrieves the length of value for a DataElement.

Returns:

int - Integer value of length.

getDataElementLength

int getDataElementLength()

Retrieves the length of DataElement.

Returns:

int - Integer value of length.

getValueMultiplicity

int getValueMultiplicity()

Retrieves the value multiplicity of the value in DataElement

Returns:

integer - returns the actual value multiplicity of value in the DataElement

setValueMultiplicity

void setValueMultiplicity(int iVM)

Sets the value multiplicity of the value of DataElement

Parameters:

iVM - value multiplicity of the value

setTag

void setTag(int iGroupNumber,
          int iElementNumber)

Sets the GroupNumber and ElementNumber of the Data Element.

Parameters:

iGroupNumber - specifies the Group Number.

iElementNumber - specifies the Element Number.

getTag

ITag getTag()

Retrieves the Tag part of the Data Element.

Returns:

ITag - Tag containing Group Number and Element Number.

getDicomValue

IDicomValue getDicomValue()

Retrieves the value part of the Data Element.

Returns:

IDicomValue - instance containing the value of the Data Element.

setDicomValue

void setDicomValue(IDicomValue objIDicomValue)

Sets the DicomValue as a value in the DataElement

Parameters:

objIDicomValue - object of DicomValue representing the value of DataElement

setTransferSyntax

void setTransferSyntax(ITransferSyntax objITransferSyntax)

Sets the transfer syntax in the DataElement object.

Parameters:

objITransferSyntax - instance of Transfer Syntax.

getTransferSyntax

ITransferSyntax getTransferSyntax()

Retrieves the TransferSyntax set in the DataElement object.

Returns:

ITransferSyntax - object of TransferSyntax set in the DataElement object.

validate

boolean validate()
                 throws InvalidDataElementException

Validates the DataElemnt according to the DICOM Rules

Returns:

boolean - status as validation success or failure

Throws:

InvalidDataElementException - If Data Element fails to satisfy Validation Criteria.

equals

boolean equals(java.lang.Object objTempObject)

Check for the equality of two objects.

Overrides:

equals in class java.lang.Object

Parameters:

objTempObject - the object to compare with.

Returns:

boolean - true if the objects are the same; false otherwise.

getValue

java.lang.Object getValue()

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

Returns:

Object - value of dicom data of the Data Element.

clone

java.lang.Object clone()

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

Returns:

IDataElement - object of IDataElement.

dumpDICOMInfo

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.

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.