cdac.medinfo.sdk.dcm30_04.baselibs

Class CodeSequenceMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.CodeSequenceMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class CodeSequenceMacro
extends Macro

This class specifies the default set of attributes encapsulated in the items of Code Sequence Attributes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CodeSequenceMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
CodeSequenceMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
CodeSequenceMacro(IItem objItem) This constructor constructs a Macro with the specified Item
CodeSequenceMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCodeMeaning() Retrieves Code Meaning.
java.lang.String	getCodeSchemeDesignator() Retrieves Code Scheme Designator.
java.lang.String	getCodeValue() Retrieves Code value.
java.lang.String	getCodingSchemeVersion() Retrieves Coding Scheme Version.
java.lang.String	getContextGroupExtensionCreatorUID() Retrieves Context Group Extension Creator UID.
java.lang.String	getContextGroupExtensionFlag() Retrieves Context Group Extension Flag.
java.lang.String	getContextGroupLocalVersion() Retrieves Context Group Local Version.
java.lang.String	getContextGroupVersion() Retrieves Context Group Version.
java.lang.String	getContextIdentifier() Retrieves Context Identifier.
java.lang.String	getMappingResource() Retrieves Mapping Resource.
java.lang.String	getSNOMEDCTID() Retrieves SNOMED-CT ID.
void	setCodeMeaning(java.lang.String strCodeMeaning) Sets Code Meaning.
void	setCodeSchemeDesignator(java.lang.String strCodeSchemeDesignator) Sets Code Scheme Designator.
void	setCodeValue(java.lang.String strCodeValue) Sets Code value.
void	setCodingSchemeVersion(java.lang.String strCodingSchemeVersion) Sets Coding Scheme Version.
void	setContextGroupExtensionCreatorUID(java.lang.String strContextGroupExtensionCreatorUID) Sets Context Group Extension Creator UID.
void	setContextGroupExtensionFlag(java.lang.String strContextGroupExtensionFlag) Sets Context Group Extension Flag.
void	setContextGroupLocalVersion(java.lang.String strContextGroupLocalVersion) Sets Context Group Local Version.
void	setContextGroupVersion(java.lang.String strContextGroupVersion) Sets Context Group Version.
void	setContextIdentifier(java.lang.String strContextIdentifier) Sets Context Identifier.
void	setMappingResource(java.lang.String strMappingResource) Sets Mapping Resource.
void	setSNOMEDCTID(java.lang.String strSNOMEDCTID) Sets SNOMED-CT ID.
boolean	validate() Validates all the attributes in CodeSequenceMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in CodeSequenceMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in CodeSequenceMacro that are present in the DataSet

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

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeSequenceMacro

public CodeSequenceMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

CodeSequenceMacro

public CodeSequenceMacro(IDataSet objDataSet,
                 IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

CodeSequenceMacro

public CodeSequenceMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

CodeSequenceMacro

public CodeSequenceMacro(IItem objItem,
                 IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

setCodeValue

public void setCodeValue(java.lang.String strCodeValue)

Sets Code value.

Parameters:

strCodeValue - -string value of Code.

getCodeValue

public java.lang.String getCodeValue()

Retrieves Code value.

Returns:

String - value of Code Value.

setCodeSchemeDesignator

public void setCodeSchemeDesignator(java.lang.String strCodeSchemeDesignator)

Sets Code Scheme Designator.

Parameters:

strCodeSchemeDesignator- - String value of Code Scheme Designator.

getCodeSchemeDesignator

public java.lang.String getCodeSchemeDesignator()

Retrieves Code Scheme Designator.

Returns:

- String value of Code Scheme Designator.

setCodingSchemeVersion

public void setCodingSchemeVersion(java.lang.String strCodingSchemeVersion)

Sets Coding Scheme Version.

Parameters:

strCodingSchemeVersion- - String value of Coding Scheme Version.

setSNOMEDCTID

public void setSNOMEDCTID(java.lang.String strSNOMEDCTID)

Sets SNOMED-CT ID.

Parameters:

strSNOMEDCTID - -String value of SNOMED-CT ID.

getSNOMEDCTID

public java.lang.String getSNOMEDCTID()

Retrieves SNOMED-CT ID.

Returns:

String -String value of SNOMED-CT ID.

getCodingSchemeVersion

public java.lang.String getCodingSchemeVersion()

Retrieves Coding Scheme Version.

Returns:

String - value of Coding Scheme Version.

setCodeMeaning

public void setCodeMeaning(java.lang.String strCodeMeaning)

Sets Code Meaning.

Parameters:

strCodeMeaning- - String value of Code Meaning.

getCodeMeaning

public java.lang.String getCodeMeaning()

Retrieves Code Meaning.

Returns:

String - value of Code Meaning.

setContextIdentifier

public void setContextIdentifier(java.lang.String strContextIdentifier)

Sets Context Identifier.

Parameters:

strContextIdentifier - -String value of Context Identifier.

getContextIdentifier

public java.lang.String getContextIdentifier()

Retrieves Context Identifier.

Returns:

String - value of Context Identifier.

setMappingResource

public void setMappingResource(java.lang.String strMappingResource)

Sets Mapping Resource.

Parameters:

strMappingResource - -String value of Mapping Resource.

getMappingResource

public java.lang.String getMappingResource()

Retrieves Mapping Resource.

Returns:

String - value of Mapping Resource.

setContextGroupVersion

public void setContextGroupVersion(java.lang.String strContextGroupVersion)

Sets Context Group Version.

Parameters:

strContextGroupVersion - -String value of Context Group Version.

getContextGroupVersion

public java.lang.String getContextGroupVersion()

Retrieves Context Group Version.

Returns:

String - value of Context Group Version.

setContextGroupExtensionFlag

public void setContextGroupExtensionFlag(java.lang.String strContextGroupExtensionFlag)

Sets Context Group Extension Flag.

Parameters:

strContextGroupExtensionFlag - -String value of Context Group Extension Flag.

getContextGroupExtensionFlag

public java.lang.String getContextGroupExtensionFlag()

Retrieves Context Group Extension Flag.

Returns:

String - value of Context Group Extension Flag.

setContextGroupLocalVersion

public void setContextGroupLocalVersion(java.lang.String strContextGroupLocalVersion)

Sets Context Group Local Version.

Parameters:

strContextGroupLocalVersion - -String value of Context Group Local Version.

getContextGroupLocalVersion

public java.lang.String getContextGroupLocalVersion()

Retrieves Context Group Local Version.

Returns:

String - value of Context Group Local Version.

setContextGroupExtensionCreatorUID

public void setContextGroupExtensionCreatorUID(java.lang.String strContextGroupExtensionCreatorUID)

Sets Context Group Extension Creator UID.

Parameters:

strContextGroupExtensionCreatorUID - -String value of Context Group Extension Creator UID.

getContextGroupExtensionCreatorUID

public java.lang.String getContextGroupExtensionCreatorUID()

Retrieves Context Group Extension Creator UID.

Returns:

String - value of Context Group Extension Creator UID.

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in CodeSequenceMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IDataSet objIDataSet)
                        throws InvalidMacroException

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

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

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

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.