com.archimed.dicom
Class DDictBase

java.lang.Object
  com.archimed.dicom.DDictBase

Direct Known Subclasses:

DDict

public class DDictBase
extends java.lang.Object

Superclass of the DDict dictionary class. This class contains constants for the different VR types and methods for looking up data element definitions and methods for adding new data element definitions to the dictionary.

When adding private tags to the dictionary, use a DDictEntry constructor that accepts a private creator ID as an argument. JDT will create a private creator ID data element if necessary an will modify the element values to take into account multiple private creators that use the same group number according to the rules specified in the DICOM standard.

Field Summary

protected static java.util.HashMap	dctList
static int	dUNDEFINED
protected static com.archimed.dicom.DDictMap	geList
static int	tAE
static int	tAS
static int	tAT
static int	tCS
static int	tDA
static int	tDS
static int	tDT
static int	tFD
static int	tFL
static int	tIS
static int	tLO
static int	tLT
static int	tNONE
static int	tOB
static int	tOF
static int	tOW
static int	tOW_OB
static int	tPN
static int	tSH
static int	tSL
static int	tSQ
static int	tSS
static int	tST
static int	tTM
static int	tUI
static int	tUL
static int	tUN
static int	tUNKNOWN This constant is identical to tUN and is retained for backwards compatability.
static int	tUS
static int	tUS_SS
static int	tUT

Constructor Summary

DDictBase()

Method Summary

static int	addEntry(DDictEntry de) adds a DDictEntry to the dictionary.
static java.util.Enumeration	ddictEntries() returns an enumeration of all entries in this dictionary.
static java.lang.String	getDescription(int dct) returns a short description of the specified tag.
static int	getElement(int dct) returns the element value of a tag for a DDict constant representing a tag.
static DDictEntry	getEntry(int dct) returns the DDictEntry instance for the specified tag.
static int	getGroup(int dct) returns the group value of a tag for a DDict constant representing a tag.
static int	getTypeCode(int dct) returns one of the DDictBase constants representing VR types (DDictBase.tXX constants) for a tag also specified by a DDict constant.
static int	getTypeCode(int g, int e) returns the VR type for a tag with specified group and element number.
static java.lang.String	getTypeCodeName(int dct) returns the two character type name (eg: US,SQ,...
static java.lang.String	getTypeName(int type) returns the two character String representing a value representation.
static int	lookupDDict(int g, int e) returns the DDict constant representing the tag for a tag with specified group and element value.

Methods inherited from class java.lang.Object

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

Field Detail

tUN

public static final int tUN

See Also:

Constant Field Values

tUNKNOWN

public static final int tUNKNOWN

This constant is identical to tUN and is retained for backwards compatability. Use tUN instead.

See Also:

Constant Field Values

tUL

public static final int tUL

See Also:

Constant Field Values

tUI

public static final int tUI

See Also:

Constant Field Values

tUS

public static final int tUS

See Also:

Constant Field Values

tAE

public static final int tAE

See Also:

Constant Field Values

tAT

public static final int tAT

See Also:

Constant Field Values

tLO

public static final int tLO

See Also:

Constant Field Values

tSH

public static final int tSH

See Also:

Constant Field Values

tOB

public static final int tOB

See Also:

Constant Field Values

tCS

public static final int tCS

See Also:

Constant Field Values

tSQ

public static final int tSQ

See Also:

Constant Field Values

tDA

public static final int tDA

See Also:

Constant Field Values

tTM

public static final int tTM

See Also:

Constant Field Values

tST

public static final int tST

See Also:

Constant Field Values

tPN

public static final int tPN

See Also:

Constant Field Values

tIS

public static final int tIS

See Also:

Constant Field Values

tDS

public static final int tDS

See Also:

Constant Field Values

tAS

public static final int tAS

See Also:

Constant Field Values

tLT

public static final int tLT

See Also:

Constant Field Values

tSL

public static final int tSL

See Also:

Constant Field Values

tFD

public static final int tFD

See Also:

Constant Field Values

tUS_SS

public static final int tUS_SS

See Also:

Constant Field Values

tOW_OB

public static final int tOW_OB

See Also:

Constant Field Values

tSS

public static final int tSS

See Also:

Constant Field Values

tOW

public static final int tOW

See Also:

Constant Field Values

tNONE

public static final int tNONE

See Also:

Constant Field Values

tFL

public static final int tFL

See Also:

Constant Field Values

tUT

public static final int tUT

See Also:

Constant Field Values

tDT

public static final int tDT

See Also:

Constant Field Values

tOF

public static final int tOF

See Also:

Constant Field Values

dUNDEFINED

public static final int dUNDEFINED

See Also:

Constant Field Values

dctList

protected static java.util.HashMap dctList

geList

protected static com.archimed.dicom.DDictMap geList

Constructor Detail

DDictBase

public DDictBase()

Method Detail

getTypeName

public static java.lang.String getTypeName(int type)

returns the two character String representing a value representation.

Parameters:

type - one of the tXX constants of DDictBase

Returns:

String a two character code

getTypeCodeName

public static java.lang.String getTypeCodeName(int dct)

returns the two character type name (eg: US,SQ,... ) for a given DDict constant representing a tag.

Parameters:

dct - a DDict constant or key to a privately added DDict entry.

Returns:

lookupDDict

public static int lookupDDict(int g,
                              int e)

returns the DDict constant representing the tag for a tag with specified group and element value.

Parameters:

g -

e -

Returns:

getGroup

public static int getGroup(int dct)

returns the group value of a tag for a DDict constant representing a tag.

Parameters:

dct -

Returns:

getElement

public static int getElement(int dct)

returns the element value of a tag for a DDict constant representing a tag.

Parameters:

dct -

Returns:

getTypeCode

public static int getTypeCode(int dct)

returns one of the DDictBase constants representing VR types (DDictBase.tXX constants) for a tag also specified by a DDict constant.

Parameters:

dct -

Returns:

one of the DDictBase.tXX constants or DDictBase.tUN if the tag is not in the dictionary.

getTypeCode

public static int getTypeCode(int g,
                              int e)

returns the VR type for a tag with specified group and element number.

Parameters:

g -

e -

Returns:

one of the DDictBase.tXX VR constants or DDictBase.tUN if the specified group,element pair is not in the dictionary.

getDescription

public static java.lang.String getDescription(int dct)

returns a short description of the specified tag.

Parameters:

dct - one of the DDict constants or privately added constants.

Returns:

ddictEntries

public static java.util.Enumeration ddictEntries()

returns an enumeration of all entries in this dictionary. Individual entries are objects of type com.archimed.DDictEntry.

getEntry

public static DDictEntry getEntry(int dct)

returns the DDictEntry instance for the specified tag.

Parameters:

a - DDict constant or privately added constant.

Returns:

addEntry

public static int addEntry(DDictEntry de)
                    throws DicomException

adds a DDictEntry to the dictionary. Returns an int that you can use as a key for this entry. Use this key in methods of DicomObject and other classes that use the DDict tag constants as one of their arguments to identify tags of the dictionary.

Parameters:

de - a DDictEntry

Returns:

a constant that can be used to reference this entry.

Throws:

DicomException - is thrown if the (group, element) - pair already exists in the DDict