DictionaryReader

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

All Implemented Interfaces:

IDictionaryReader, java.io.Serializable
```
public class DictionaryReader
extends java.lang.Object
implements IDictionaryReader
```
This is a Thread safe Singleton class which provides facility to read data elements from DataDictionary. It uses DataDictionaryProvider to access DataDictionary. Dictionary Reader provides the flexibility for the user to use the default dictionary provided with the library or use his/her own dictionary. Dictionary Reader is the implementation provided by the library which uses default dictionary written in xml file. User can extend from it or implement IDictionaryReader interface to create his/her own dictionary reader and provide dictionary from where he/she stored it e.g. in a file or database. In this case user has to override populate() method of the dictionary reader. In the populate method, all that user has to do is basically retrieve the data from wherever he has kept it and call makeEntry method of DictionaryDataProvider to fill the dictionary at runtime. To create dictionary reader reading from xml file of data dictionary, steps required are: IDictionaryReader objIDictionaryReader = DictionaryReader.createInstance(xmlfile, xsdfile); objIDictionaryReader.populate(); To create dictionary reader reading from a place, steps required are: IDictionaryReader objIDictionaryReader = DictionaryReader.createInstance(); //override populate method to populate the dictionary from which dictionary reader can read. objIDictionaryReader.populate(); Using dictionary reader, user can retrieve the information based on the tag value. User can retreive name, value representation, minimum value multiplicity, maximum value multiplicity, retired status. Note: Some data elements are declared as retired from DICOM PS3 2004 standard. The retired status can also be retrieved through the dictionary reader.

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`static DictionaryReader`	`createInstance()` Returns instance of Dictionary Reader if not created.
`static DictionaryReader`	`createInstance(java.lang.String strXMLFile, java.lang.String strXSDFile)` Constructs a RegistryTransactionAgent object and ensures that it is singleton.
`int`	`getMaxVM(int iGroupNumber, int iElementNumber)` Returns the maximum Value Multiplicity specified by Dicom Standard for the specified Tag VR Type represents the maximum Value Multiplicity for the specified Tag.
`int`	`getMinVM(int iGroupNumber, int iElementNumber)` Returns the minimum Value Multiplicity specified by Dicom Standard for the specified Tag VR Type represents the minimum Value Multiplicity for the specified Tag
`java.lang.String`	`getName(int iGroupNumber, int iElementNumber)` Returns the name specified by Dicom Standard for the specified Tag
`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)` Returns the VR Type specified by Dicom Standard for the specified Tag VR Type represents the Value Representation for the specified Tag
`boolean`	`isDictionaryPopulated()` Returns the status of Dictionary whether it is populated or not.
`boolean`	`isRetired(int iGroupNumber, int iElementNumber)` Returns the status indicating whether the specified tag is retired from Dicom V3-2004 Standard Specification.
`boolean`	`isVRValid(ITag objITag, int iVRType)` Validates if the Value Representation(VR) and the Tag match according to the Data Dictionary.
`void`	`populate()` Populates the Dictionary Data Provider with all the attributes from the Data Dictionary.

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

- Method Detail
  - createInstance
```
public static DictionaryReader createInstance()
                                       throws InvalidDictionaryException
```
    Returns instance of Dictionary Reader if not created.
    
    Returns:
    - instance of DictionaryReader.
    
    Throws:
    
    InvalidDictionaryException
  - populate
```
public void populate()
              throws InvalidDictionaryException
```
    Populates the Dictionary Data Provider with all the attributes from the Data Dictionary.
    
    Specified by:
    
    populate in interface IDictionaryReader
    
    Throws:
    
    InvalidDictionaryException
  - createInstance
```
public static DictionaryReader createInstance(java.lang.String strXMLFile,
                              java.lang.String strXSDFile)
```
    Constructs a RegistryTransactionAgent object and ensures that it is singleton. This method reads XML and XSD file path from application.
    
    Parameters:
    strXMLFile - String containing the XML File path.
    strXSDFile - String containing the XSD File path.
    
    Returns:
    objRegistryTransactionAgent - object of RegistryTransactionAgent
  - isDictionaryPopulated
```
public boolean isDictionaryPopulated()
```
    Returns the status of Dictionary whether it is populated or not.
    
    Specified by:
    
    isDictionaryPopulated in interface IDictionaryReader
    
    Returns:
    boolean - true, when data dictionary is populated.
  - getName
```
public java.lang.String getName(int iGroupNumber,
                       int iElementNumber)
```
    Returns the name specified by Dicom Standard for the specified Tag
    
    Specified by:
    
    getName in interface IDictionaryReader
    
    Parameters:
    iGroupNumber - Group Number of Tag.
    iElementNumber - Element Number of Tag.
    
    Returns:
    String - returns the name specified by Dicom Standard for the specified Tag
  - getVR
```
public java.lang.String getVR(int iGroupNumber,
                     int iElementNumber)
```
    Returns the VR Type specified by Dicom Standard for the specified Tag VR Type represents the Value Representation for the specified Tag
    
    Specified by:
    
    getVR in interface IDictionaryReader
    
    Parameters:
    iGroupNumber - Group Number of Tag.
    iElementNumber - Element Number of Tag.
    
    Returns:
    String - returns the VR Type specified by Dicom Standard for the specified Tag
  - getMinVM
```
public int getMinVM(int iGroupNumber,
           int iElementNumber)
```
    Returns the minimum Value Multiplicity specified by Dicom Standard for the specified Tag VR Type represents the minimum Value Multiplicity for the specified Tag
    
    Specified by:
    
    getMinVM in interface IDictionaryReader
    
    Parameters:
    iGroupNumber - Group Number of Tag.
    iElementNumber - Element Number of Tag.
    
    Returns:
    integer - returns the VM specified by Dicom Standard for the specified Tag
  - getMaxVM
```
public int getMaxVM(int iGroupNumber,
           int iElementNumber)
```
    Returns the maximum Value Multiplicity specified by Dicom Standard for the specified Tag VR Type represents the maximum Value Multiplicity for the specified Tag.
    
    Specified by:
    
    getMaxVM in interface IDictionaryReader
    
    Parameters:
    iGroupNumber - Group Number of Tag.
    iElementNumber - Element Number of Tag.
    
    Returns:
    integer - returns the VM specified by Dicom Standard for the specified Tag.
  - isRetired
```
public boolean isRetired(int iGroupNumber,
                int iElementNumber)
```
    Returns the status indicating whether the specified tag is retired from Dicom V3-2004 Standard Specification.
    
    Specified by:
    
    isRetired in interface IDictionaryReader
    
    Parameters:
    iGroupNumber - Group Number of Tag.
    iElementNumber - Element Number of Tag.
    
    Returns:
    boolean - the status indicating whether the specified tag is retired from Dicom V3-2004 Standard Specification
  - isVRValid
```
public boolean isVRValid(ITag objITag,
                int iVRType)
```
    Validates if the Value Representation(VR) and the Tag match according to the Data Dictionary.
    
    Parameters:
    objITag - Tag need to be verified.
    iVRType - Value Representation to be matched.
    
    Returns:
    - success, if the Tag & VR match with Data Dictionary. false, if match is failed.
  - 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 IDictionaryReader
    
    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 DictionaryReader

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createInstance

populate

createInstance

isDictionaryPopulated

getName

getVR

getMinVM

getMaxVM

isRetired

isVRValid

getTag