cdac.medinfo.sdk.dcm30_04.services.dimsecommons

Class CommandSet

java.lang.Object

cdac.medinfo.sdk.dcm30_04.services.dimsecommons.CommandSet

All Implemented Interfaces:

ICommandSet

public class CommandSet
extends java.lang.Object
implements ICommandSet

This class is used as a Command Set in Dicom which holds the Command Elements in increasing order of Tag number.

Constructor Summary

Constructors

Constructor and Description
CommandSet() Instantiates Command set with default transfer syntax and dictionary reader.
CommandSet(IDictionaryReader objIDictionaryReader_) Instantiates Command Set with Dictionary Reader specified by the user.

Method Summary

Methods

Modifier and Type	Method and Description
int	addCommandElement(ICommandElement objICommandElement) Adds the Command Element to the Command Set.
byte[]	getBytes(int iNumberOfBytes) Retrieves the number of bytes from CommandSet.
int	getCommandSetLength() Retrieves the length of Command Set.
ICommandElement	getDataForTag(int iGroupNumber, int iElementNumber) Retrieves the Command Element for the specified tag.
IDictionaryReader	getDictionaryReader() Retrieves the DictionaryReader set in the Command Set.
ITransferSyntax	getTransferSyntax() The implementation of this method retrieves the TransferSyntax set in the Command Set.
java.lang.Object	getValue(int iGroupNumber, int iElementNumber) Retrieves the value of DicomValue.
boolean	isAvailable() Shows the availability of CommandElement in CommandSet.
boolean	isEmpty() Checks whether Command set is empty or not.
boolean	isPresent(int iGroupNumber, int iElementNumber) The implementation of this method checks that element is present in Command set or not.
ICollectionIterator<ICommandElement>	iterator() Provides iterator over the collection of Command Elements.
int	parse(IDicomStream objIDicomStream) The implementation of this method parses the Command Set from the given Stream.
int	serialize(IDicomStream objIDicomStream) Serializes the CommandSet to the given Stream.
boolean	validate() validates the CommandSet for proper ordering of CommandElements.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandSet

public CommandSet()

Instantiates Command set with default transfer syntax and dictionary reader.

CommandSet

public CommandSet(IDictionaryReader objIDictionaryReader_)

Instantiates Command Set with Dictionary Reader specified by the user.

Parameters:

objIDictionaryReader_ - Dictionary reader used by the data set.

Method Detail

getDictionaryReader

public IDictionaryReader getDictionaryReader()

Retrieves the DictionaryReader set in the Command Set.

Specified by:

getDictionaryReader in interface ICommandSet

Returns:

IDictionaryReader - instance of DictionaryReader.

parse

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

The implementation of this method parses the Command Set from the given Stream.

Specified by:

parse in interface ICommandSet

Parameters:

objIDicomStream - Stream on which the DICOM data is available.

Returns:

int - shows status as success or failure.

Throws:

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

InvalidDataSetException - If DataSet fails to satisfy validation criteria.

getCommandSetLength

public int getCommandSetLength()

Retrieves the length of Command Set.

Specified by:

getCommandSetLength in interface ICommandSet

Returns:

int - Lenght of Command Set.

serialize

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

Serializes the CommandSet to the given Stream.

Specified by:

serialize in interface ICommandSet

Parameters:

objIDicomStream - instance of DicomStream

Returns:

int - shows status as success or failure.

Throws:

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

getDataForTag

public ICommandElement getDataForTag(int iGroupNumber,
                            int iElementNumber)

Retrieves the Command Element for the specified tag.

Specified by:

getDataForTag in interface ICommandSet

Parameters:

iGroupNumber - Group Number of the Command Element

iElementNumber - Element Number of the Command Element

Returns:

IDataElement - instance of Command Element retrieved from the CommandSet or NULL if the Command Element is not found in the CommandSet

addCommandElement

public int addCommandElement(ICommandElement objICommandElement)

Adds the Command Element to the Command Set.

Specified by:

addCommandElement in interface ICommandSet

Parameters:

objICommandElement - instance of Command Element

Returns:

int - the status indicating success/failure.

iterator

public ICollectionIterator<ICommandElement> iterator()

Provides iterator over the collection of Command Elements.

Returns:

ICollectionIterator - custom iterator over the collection of CommandElements

isPresent

public boolean isPresent(int iGroupNumber,
                int iElementNumber)

The implementation of this method checks that element is present in Command set or not.

Specified by:

isPresent in interface ICommandSet

Parameters:

iGroupNumber - value of group number.

iElementNumber - value of element number.

Returns:

boolean - shows status as success or failure.

isEmpty

public boolean isEmpty()

Checks whether Command set is empty or not.

Specified by:

isEmpty in interface ICommandSet

Returns:

boolean - shows status as success or failure.

getTransferSyntax

public ITransferSyntax getTransferSyntax()

The implementation of this method retrieves the TransferSyntax set in the Command Set.

Specified by:

getTransferSyntax in interface ICommandSet

Returns:

ITransferSyntax - instance of TransferSyntax.

validate

public boolean validate()
                 throws InvalidCommandSetException

validates the CommandSet for proper ordering of CommandElements.

Specified by:

validate in interface ICommandSet

Returns:

boolean - status indicating success or failure

Throws:

InvalidCommandSetException - - If CommandSet fails to satisfy validation criteria.

getBytes

public byte[] getBytes(int iNumberOfBytes)
                throws java.io.IOException

Retrieves the number of bytes from CommandSet.

Specified by:

getBytes in interface ICommandSet

Parameters:

iNumberOfBytes - number of bytes to retrieve.

Returns:

byte[] - array of bytes.

Throws:

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

getValue

public java.lang.Object getValue(int iGroupNumber,
                        int iElementNumber)

Retrieves the value of DicomValue.

Specified by:

getValue in interface ICommandSet

Parameters:

iGroupNumber - Group Number of the DataElement

iElementNumber - Element Number of the DataElement

Returns:

Object - instance of IDicomValue.

isAvailable

public boolean isAvailable()

Shows the availability of CommandElement in CommandSet.

Specified by:

isAvailable in interface ICommandSet

Returns:

boolean - status true if available else false.