cdac.medinfo.sdk.dcm30_04.baselibs

Class DimensionIndexSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.DimensionIndexSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class DimensionIndexSequenceItem
extends Item

This item class contains methods to validate, set and get attributes in Dimension Index Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDimensionDescriptionLabel() Return user-defined label identifier for Dimension Description Label.
ISingleCollection<ITag>	getDimensionIndexPointer() Retrieves the Data Element Tag that is used to identify the Attribute connected with the index.
java.lang.String	getDimensionIndexPrivateCreator() Retrieves uniquely identifies a set of dimensions referenced within the containing SOP Instance.
java.lang.String	getDimensionOrganizationUID() Retrieves identification of the creator of a group of private data elements.
ISingleCollection<ITag>	getFunctionalGroupPointer() Retrieves the Data Element Tag of the Functional Group Sequence that contains the Attribute that is referenced by the Dimension Index Pointer (0020,9165).
java.lang.String	getFunctionalGroupPrivateCreator() Retrieves identification of the creator of a group of private data elements.
void	setDimensionDescriptionLabel(java.lang.String strRescaleType) Sets DimensionDescriptionLabel.
void	setDimensionIndexPointer(ISingleCollection<ITag> objSingleCollection) Sets the Data Element Tag that is used to identify the Attribute connected with the index.
void	setDimensionIndexPrivateCreator(java.lang.String strDimensionIndexPrivateCreator) Sets identification of the creator of a group of private data elements.
void	setDimensionOrganizationUID(java.lang.String strDimensionOrganizationUID) Sets uniquely identifies a set of dimensions referenced within the containing SOP Instance.
void	setFunctionalGroupPointer(ISingleCollection<ITag> objSingleCollection) Sets the Data Element Tag of the Functional Group Sequence that contains the Attribute that is referenced by the Dimension Index Pointer (0020,9165).
void	setFunctionalGroupPrivateCreator(java.lang.String strFunctionalGroupPrivateCreator) Sets identification of the creator of a group of private data elements.
boolean	validateForModule() Validates all the attributes in DimensionIndexSequenceItem that are present in the DataSet

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

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in DimensionIndexSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setDimensionIndexPointer

public void setDimensionIndexPointer(ISingleCollection<ITag> objSingleCollection)

Sets the Data Element Tag that is used to identify the Attribute connected with the index.

Parameters:

objSingleCollection - Collection of Tags (GroupNumber and ElementNumbers)

getDimensionIndexPointer

public ISingleCollection<ITag> getDimensionIndexPointer()

Retrieves the Data Element Tag that is used to identify the Attribute connected with the index.

Returns:

ISingleCollection - Collection of Tags (GroupNumber and ElementNumbers)

setDimensionIndexPrivateCreator

public void setDimensionIndexPrivateCreator(java.lang.String strDimensionIndexPrivateCreator)

Sets identification of the creator of a group of private data elements.

Parameters:

strDimensionIndexPrivateCreator - String value of Dimension Index Private Creator.

getDimensionIndexPrivateCreator

public java.lang.String getDimensionIndexPrivateCreator()

Retrieves uniquely identifies a set of dimensions referenced within the containing SOP Instance.

Returns:

String - value of Dimension Index Private Creator.

setFunctionalGroupPointer

public void setFunctionalGroupPointer(ISingleCollection<ITag> objSingleCollection)

Sets the Data Element Tag of the Functional Group Sequence that contains the Attribute that is referenced by the Dimension Index Pointer (0020,9165).

Parameters:

objSingleCollection - Collection of Tags (GroupNumber and ElementNumbers).

getFunctionalGroupPointer

public ISingleCollection<ITag> getFunctionalGroupPointer()

Retrieves the Data Element Tag of the Functional Group Sequence that contains the Attribute that is referenced by the Dimension Index Pointer (0020,9165).

Returns:

ISingleCollection - Collection of Tags (GroupNumber and ElementNumbers)

setFunctionalGroupPrivateCreator

public void setFunctionalGroupPrivateCreator(java.lang.String strFunctionalGroupPrivateCreator)

Sets identification of the creator of a group of private data elements.

Parameters:

strFunctionalGroupPrivateCreator - String value of Functional Group Private Creator.

getFunctionalGroupPrivateCreator

public java.lang.String getFunctionalGroupPrivateCreator()

Retrieves identification of the creator of a group of private data elements.

Returns:

String - value of Functional Group Private Creator.

setDimensionOrganizationUID

public void setDimensionOrganizationUID(java.lang.String strDimensionOrganizationUID)

Sets uniquely identifies a set of dimensions referenced within the containing SOP Instance. In particular the dimension described by this sequence item is associated with this Dimension Organization UID.

Parameters:

strDimensionOrganizationUID - string value uniquely identifies dimensions referenced within the containing SOP Instance.

getDimensionOrganizationUID

public java.lang.String getDimensionOrganizationUID()

Retrieves identification of the creator of a group of private data elements.

Returns:

String - value uniquely identifies dimensions referenced within the containing SOP Instance.

setDimensionDescriptionLabel

public void setDimensionDescriptionLabel(java.lang.String strRescaleType)

Sets DimensionDescriptionLabel.

Parameters:

strDimensionDescriptionLabel - String value of DimensionDescriptionLabel.

getDimensionDescriptionLabel

public java.lang.String getDimensionDescriptionLabel()

Return user-defined label identifier for Dimension Description Label.

Returns:

String - value of DimensionDescriptionLabel.