cdac.medinfo.sdk.dcm30_04.commoninterface

Interface IDictionaryDataProvider

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DictionaryDataProvider

public interface IDictionaryDataProvider
extends java.io.Serializable

This interface needs to be implemented by all classes which implements the necessary functionality for the Dictionary Data Provider.

Method Summary

Methods

Modifier and Type	Method and Description
int	getMaxVM(int iGroupNumber, int iElementNumber) Retrieves maximum value multiplicity of the element.
int	getMinVM(int iGroupNumber, int iElementNumber) Retrieves minimum value multiplicity of the element.
java.lang.String	getName(int iGroupNumber, int iElementNumber) Retrieves the name of the element.
short[]	getTag(java.lang.String strDataElementName) Retrieves the Group Number and Element Number of Attribute Name provided.
java.lang.String	getVR(int iGroupNumber, int iElementNumber) Retrieves the VR type of element.
boolean	isElementNumberPresent(int iElementNumber) Checks that given element number is present or not.
boolean	isGroupNumberPresent(int iGroupNumber) Checks that given group number is present or not.
boolean	isPopulated() Checks that data dictionary is populated or not.
boolean	isRetired(int iGroupNumber, int iElementNumber) Checks the current status of element whether it's retired or not.
boolean	isStandardTag(int iGroupNumber, int iElementNumber) Checks that given group number and element number constructs a valid tag.
boolean	isVRPresent(java.lang.String strVR) Checks that given VR type is present or not.
void	makeEntry(int iGroupNumber, int iElementNumber, java.lang.String strElementName, java.lang.String strVR, int iMinVM, int iMaxVM, boolean isRetired) Creates a new entry for data Dictionary.

Method Detail

makeEntry

void makeEntry(int iGroupNumber,
             int iElementNumber,
             java.lang.String strElementName,
             java.lang.String strVR,
             int iMinVM,
             int iMaxVM,
             boolean isRetired)

Creates a new entry for data Dictionary.

Parameters:

iGroupNumber - integer value of group number.

iElementNumber - integer value of element number

strElementName - String value of element name.

strVR - String value of VR type.

iMinVM - integer value of minimum value multiplicity.

iMaxVM - integer value of maximum value multiplicity.

isRetired - boolean value shows status of element.

getVR

java.lang.String getVR(int iGroupNumber,
                     int iElementNumber)

Retrieves the VR type of element.

Parameters:

iGroupNumber - integer value of group number.

iElementNumber - integer value of element number.

Returns:

String - String value of VR type.

getMinVM

int getMinVM(int iGroupNumber,
           int iElementNumber)

Retrieves minimum value multiplicity of the element.

Parameters:

iGroupNumber - Integer value of group number.

iElementNumber - Integer value of element number.

Returns:

int - integer value of minimum value multiplicity.

getMaxVM

int getMaxVM(int iGroupNumber,
           int iElementNumber)

Retrieves maximum value multiplicity of the element.

Parameters:

iGroupNumber - Integer value of group number.

iElementNumber - Integer value of element number.

Returns:

int - integer value of minimum value multiplicity.

getName

java.lang.String getName(int iGroupNumber,
                       int iElementNumber)

Retrieves the name of the element.

Parameters:

iGroupNumber - Integer value of group number.

iElementNumber - Integer value of element number.

Returns:

String - name of the element.

isRetired

boolean isRetired(int iGroupNumber,
                int iElementNumber)

Checks the current status of element whether it's retired or not.

Parameters:

iGroupNumber - Integer value of group number.

iElementNumber - Integer value of element number.

Returns:

boolean - shows status of element.

isGroupNumberPresent

boolean isGroupNumberPresent(int iGroupNumber)

Checks that given group number is present or not.

Parameters:

iGroupNumber - Integer value of element number.

Returns:

boolean - shows presence of element number.

isElementNumberPresent

boolean isElementNumberPresent(int iElementNumber)

Checks that given element number is present or not.

Parameters:

iElementNumber - Integer value of element number.

Returns:

boolean - shows presence of element number.

isVRPresent

boolean isVRPresent(java.lang.String strVR)

Checks that given VR type is present or not. VR Type represents the Value Representation for the specified Tag.

Parameters:

strVR - string value of VR type.

Returns:

boolean - shows presence of VR type.

isStandardTag

boolean isStandardTag(int iGroupNumber,
                    int iElementNumber)

Checks that given group number and element number constructs a valid tag.

Parameters:

iGroupNumber - Integer value of group number.

iElementNumber - Integer value of element number.

Returns:

boolean - shows validity of tag.

isPopulated

boolean isPopulated()

Checks that data dictionary is populated or not.

Returns:

boolean - shows status of dictionary.

getTag

short[] getTag(java.lang.String strDataElementName)

Retrieves the Group Number and Element Number of Attribute Name provided. This function return a short array in which element at index 0 is Group Number and at index 1 is Element Number.

Parameters:

strDataElementName - String value of Data Element name.

Returns:

short[] - return short array. The element at index 0 represents Group Number and at index 1 represents Element Number.