cdac.medinfo.sdk.dcm30_04.services.dimsecommons

Class CommandElement

java.lang.Object

cdac.medinfo.sdk.dcm30_04.services.dimsecommons.CommandElement

All Implemented Interfaces:

ICommandElement

public class CommandElement
extends java.lang.Object
implements ICommandElement

This class represents Command Element of Dicom which reads the datatype of its value from the DataDictionary provided to it.

Constructor Summary

Constructors

Constructor and Description
CommandElement(int iGroupNumber, int iElementNumber, java.lang.Object objValue) This constructor can be used to create a Command Element.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCommandElementLength() Retrieves the length of Command Element
IDicomValue	getDicomValue() Retrieves the value part of the Command Element.
IDictionaryReader	getDictionaryReader() Retrieves the dictionaryreader set in the CommandElement.
int	getLength() Retrieves the length part of the Command Element.
ITag	getTag() Retrieves the Tag part of the Command Element.
ITransferSyntax	getTransferSyntax() Retrieves the TransferSyntax set in the CommandElement object.
int	getValueLength() Retrieves value length of Command element.
int	getValueMultiplicity() Retrieves the value multiplicity of the value.
int	parse(IDicomStream objIDicomStream) Reads the Command Element from the given Stream.
int	serialize(IDicomStream objIDicomStream) Writes the Command Element to the given Stream.
void	setCommandElementLength() Sets the length of Command Element.
void	setDicomValue(IDicomValue objDicomValue) Sets the DicomValue as a value in the CommandElement.
void	setDictionaryReader(IDictionaryReader objIDictionaryReader) Sets the Dictionary Reader.
void	setLength(int iValueLength) Sets the length part of the Command Element.
void	setTag(int iGroupNumber, int iElementNumber) Sets the Tag in Command Element.
void	setValueMultiplicity(int iVM) Sets the value multiplicity of the value in the CommandElement.

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdac.medinfo.sdk.dcm30_04.services.dicomnetcommons.ICommandElement

equals

Constructor Detail

CommandElement

public CommandElement(int iGroupNumber,
              int iElementNumber,
              java.lang.Object objValue)
               throws InvalidCommandElementException

This constructor can be used to create a Command Element.

Parameters:

iGroupNumber - GroupNumber from the Tag identifying this Command Element

iElementNumber - ElementNumber from the Tag identifying this Command Element

objValue - value of the Command Element

Throws:

InvalidCommandElementException - If Command Element is invalid

Method Detail

getLength

public int getLength()

Retrieves the length part of the Command Element.

Specified by:

getLength in interface ICommandElement

Returns:

int - Length part of Data Element.

setLength

public void setLength(int iValueLength)

Sets the length part of the Command Element.

Specified by:

setLength in interface ICommandElement

Parameters:

iValueLength - Length part of Data Element.

getValueLength

public int getValueLength()

Retrieves value length of Command element.

Specified by:

getValueLength in interface ICommandElement

Returns:

int - value length of Command element

getValueMultiplicity

public int getValueMultiplicity()

Retrieves the value multiplicity of the value.

Specified by:

getValueMultiplicity in interface ICommandElement

Returns:

integer - the value multiplicity of the value in CommandElement

setValueMultiplicity

public void setValueMultiplicity(int iVM)

Sets the value multiplicity of the value in the CommandElement.

Specified by:

setValueMultiplicity in interface ICommandElement

Parameters:

iVM - value multiplicity of the value

setTag

public void setTag(int iGroupNumber,
          int iElementNumber)

Sets the Tag in Command Element.

Specified by:

setTag in interface ICommandElement

Parameters:

iGroupNumber - Value of Group Number.

iElementNumber - Value of Element Number.

getTag

public ITag getTag()

Retrieves the Tag part of the Command Element.

Specified by:

getTag in interface ICommandElement

Returns:

ITag - Tag containing Group Number and Element Number.

getDicomValue

public IDicomValue getDicomValue()

Retrieves the value part of the Command Element.

Specified by:

getDicomValue in interface ICommandElement

Returns:

IDicomValue - instance containing the value of the Command Element

setDicomValue

public void setDicomValue(IDicomValue objDicomValue)

Sets the DicomValue as a value in the CommandElement.

Specified by:

setDicomValue in interface ICommandElement

Parameters:

objDicomValue - instance of DicomValue representing the value of CommandElement

setDictionaryReader

public void setDictionaryReader(IDictionaryReader objIDictionaryReader)

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

Parameters:

objIDictionaryReader - instance of DictionaryReader to read from the Dictionary.

getDictionaryReader

public IDictionaryReader getDictionaryReader()

Retrieves the dictionaryreader set in the CommandElement.

Returns:

objIDictionaryReader - instance of dictionary reader set in the Implicit DataElement

parse

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

Reads the Command Element from the given Stream.

Specified by:

parse in interface ICommandElement

Parameters:

objIDicomStream - instance of Dicom Stream

Returns:

int - shows status as success or failure.

Throws:

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

InvalidCommandElementException - If Data Element fails to satisfy Validation Criteria.

serialize

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

Writes the Command Element to the given Stream.

Specified by:

serialize in interface ICommandElement

Parameters:

objIDicomStream - instance of Dicom Stream

Returns:

int - shows status as success or failure.

Throws:

InvalidDataTypeException - If DataType validation fails.

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

setCommandElementLength

public void setCommandElementLength()

Sets the length of Command Element.

Specified by:

setCommandElementLength in interface ICommandElement

getCommandElementLength

public int getCommandElementLength()

Retrieves the length of Command Element

Specified by:

getCommandElementLength in interface ICommandElement

Returns:

int - value of length.

getTransferSyntax

public ITransferSyntax getTransferSyntax()

Retrieves the TransferSyntax set in the CommandElement object.

Specified by:

getTransferSyntax in interface ICommandElement

Returns:

ITransferSyntax - instance of TransferSyntax set in the CommandElement object.