DictionaryDataProvider

java.lang.Object
- cdac.medinfo.sdk.dcm30_04.dictionaryreaderwriters.DictionaryDataProvider

All Implemented Interfaces:

IDictionaryDataProvider, java.io.Serializable
```
public class DictionaryDataProvider
extends java.lang.Object
implements IDictionaryDataProvider
```
DictionaryDataProvider is a class which implements Interface IDictionaryDataProvider. The interface specifies the required functionality for the data dictionary to be populated according to the DICOM PS3 2004 standard. The data dictionary contains description of data elements which consists of name, value representation, min and max value multiplicity and status indicating whether the element is retired in this version or not. IDictionaryDataProvider interface represents the runtime representation of the dictionary. User can create any runtime data holder classes for each entry as defined in DICOM standard. The user needs to provide data to makeEntry method of DictionaryDataProvider which basically passes the data to these runtime classes. Once the dictionary is populated through populate method, DictionaryDataProvider can be used to access the data. Any implementation of IDictionaryDataProvider should provide mechanism to retrieve the data How SDK's default implementation works? DictionaryDataProvider internally holds the data provided to it through makeEntry method. If user implements IDicitonaryDataProvider interface, then he/she has to internally maintain the data provided by makeEntry method. There is no need to extend from DictionaryDataProvider if user don't want to internally maintain the data provided by makeEntry method. DictionaryReader reads dictionary data from xml file through populate method. If user implements IDictionaryReader interface, he/she has to give the implementation of populate method. If user extends from DictionaryReader class, then he/she has to override the populate method in which he/she has to call makeEntry method of DictionaryDataProvider.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

DictionaryDataProvider()
Default Constructor for DictionaryDataProvider which creates an instance of DataDictionary.

Constructors
Constructor and Description
`DictionaryDataProvider()` Default Constructor for DictionaryDataProvider which creates an instance of DataDictionary.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getMaxVM(int iGroupNumber, int iElementNumber)` Retrieves the maximum value multiplicity of the element.
`int`	`getMinVM(int iGroupNumber, int iElementNumber)` Retrieves the 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 the element.
`boolean`	`isElementNumberPresent(int iElementNumber)` This method checks that given element number is present or not.
`boolean`	`isGroupNumberPresent(int iGroupNumber)` This method 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)` This method checks that given group number and element number contructs a valid tag.
`boolean`	`isVRPresent(java.lang.String strVR)` This method 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)` This method makes an entry in DataDictionary for given values of fields for an element.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DictionaryDataProvider
```
public DictionaryDataProvider()
```
    Default Constructor for DictionaryDataProvider which creates an instance of DataDictionary.
- Method Detail
  - makeEntry
```
public void makeEntry(int iGroupNumber,
             int iElementNumber,
             java.lang.String strElementName,
             java.lang.String strVR,
             int iMinVM,
             int iMaxVM,
             boolean isRetired)
```
    This method makes an entry in DataDictionary for given values of fields for an element.
    
    Specified by:
    
    makeEntry in interface IDictionaryDataProvider
    
    Parameters:
    iGroupNumber - Integer value of group number.
    iElementNumber - Integer value of element number.
    strElementName - Name of the attribute.
    strVR - string value of VR type of an element.
    iMinVM - Minimum integer value multiplicity of an element.
    iMaxVM - Maximum integer value multiplicity of an element.
    isRetired - - Shows the current status of element.
  - getName
```
public java.lang.String getName(int iGroupNumber,
                       int iElementNumber)
```
    Retrieves the name of the element.
    
    Specified by:
    
    getName in interface IDictionaryDataProvider
    
    Parameters:
    iGroupNumber - Integer value of group number.
    iElementNumber - Integer value of element number.
    
    Returns:
    String - name of the element.
  - getVR
```
public java.lang.String getVR(int iGroupNumber,
                     int iElementNumber)
```
    Retrieves the VR type of the element. VR Type represents the Value Representation for the specified Tag.
    
    Specified by:
    
    getVR in interface IDictionaryDataProvider
    
    Parameters:
    iGroupNumber - Integer value of group number.
    iElementNumber - Integer value of element number.
    
    Returns:
    String - VR type of the element.
  - getMinVM
```
public int getMinVM(int iGroupNumber,
           int iElementNumber)
```
    Retrieves the minimum value multiplicity of the element.
    
    Specified by:
    
    getMinVM in interface IDictionaryDataProvider
    
    Parameters:
    iGroupNumber - Integer value of group number.
    iElementNumber - Integer value of element number.
    
    Returns:
    int - integer value of minimum value multiplicity
  - getMaxVM
```
public int getMaxVM(int iGroupNumber,
           int iElementNumber)
```
    Retrieves the maximum value multiplicity of the element.
    
    Specified by:
    
    getMaxVM in interface IDictionaryDataProvider
    
    Parameters:
    iGroupNumber - Integer value of group number.
    iElementNumber - Integer value of element number.
    
    Returns:
    int - integer value of maximum value multiplicity
  - isRetired
```
public boolean isRetired(int iGroupNumber,
                int iElementNumber)
```
    Checks the current status of element whether it's retired or not.
    
    Specified by:
    
    isRetired in interface IDictionaryDataProvider
    
    Parameters:
    iGroupNumber - Integer value of group number.
    iElementNumber - Integer value of element number.
    
    Returns:
    boolean - shows status of element.
  - isGroupNumberPresent
```
public boolean isGroupNumberPresent(int iGroupNumber)
```
    This method checks that given group number is present or not.
    
    Specified by:
    
    isGroupNumberPresent in interface IDictionaryDataProvider
    
    Parameters:
    iGroupNumber - Integer value of group number.
    
    Returns:
    boolean - shows presence of group number.
  - isElementNumberPresent
```
public boolean isElementNumberPresent(int iElementNumber)
```
    This method checks that given element number is present or not.
    
    Specified by:
    
    isElementNumberPresent in interface IDictionaryDataProvider
    
    Parameters:
    iElementNumber - Integer value of element number.
    
    Returns:
    boolean - shows presence of element number.
  - isVRPresent
```
public boolean isVRPresent(java.lang.String strVR)
```
    This method checks that given VR type is present or not. VR Type represents the Value Representation for the specified Tag
    
    Specified by:
    
    isVRPresent in interface IDictionaryDataProvider
    
    Parameters:
    strVR - string value of VR type.
    
    Returns:
    boolean - shows presence of VR type.
  - isStandardTag
```
public boolean isStandardTag(int iGroupNumber,
                    int iElementNumber)
```
    This method checks that given group number and element number contructs a valid tag.
    
    Specified by:
    
    isStandardTag in interface IDictionaryDataProvider
    
    Parameters:
    iGroupNumber - Integer value of group number.
    iElementNumber - Integer value of element number.
    
    Returns:
    boolean - shows validity of tag.
  - isPopulated
```
public boolean isPopulated()
```
    Checks that data dictionary is populated or not.
    
    Specified by:
    
    isPopulated in interface IDictionaryDataProvider
    
    Returns:
    boolean - shows status of dictionary.
  - getTag
```
public 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.
    
    Specified by:
    
    getTag in interface IDictionaryDataProvider
    
    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.

Class DictionaryDataProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DictionaryDataProvider

Method Detail

makeEntry

getName

getVR

getMinVM

getMaxVM

isRetired

isGroupNumberPresent

isElementNumberPresent

isVRPresent

isStandardTag

isPopulated

getTag