org.dcm4che.data
Interface DcmObject

All Known Subinterfaces:
Command, Dataset, FileMetaInfo

public interface DcmObject

Defines common behavior of Command, Dataset, and FileMetaInfo container objects.

Version:
$Revision: 8442 $ $Date: 2008-11-28 12:31:02 +0100 (Fr, 28 Nov 2008) $

Revisions:

20020722 gunter:

Author:
gunter zeilinger
See Also:
"DICOM Part 5: Data Structures and Encoding, 7. The Data Set"

Field Summary
static int ADD_ITEMS
          Constant for itemTreatment param of @link {#putAll(dcmObj, int itemTreatment)}
static int MERGE_ITEMS
          Constant for itemTreatment param of @link {#putAll(dcmObj, int itemTreatment)}
static int REPLACE_ITEMS
          Constant for itemTreatment param of @link {#putAll(dcmObj, int itemTreatment)}
 
Method Summary
 void clear()
           
 boolean contains(int tag)
           
 boolean containsValue(int tag)
           
 DcmElement get(int tag)
           
 java.lang.String getBoundedString(int maxLen, int tag)
           
 java.lang.String getBoundedString(int maxLen, int tag, int index)
           
 java.lang.String getBoundedString(int maxLen, int tag, int index, java.lang.String defVal)
           
 java.lang.String getBoundedString(int maxLen, int tag, java.lang.String defVal)
           
 java.lang.String[] getBoundedStrings(int maxLen, int tag)
           
 java.nio.ByteBuffer getByteBuffer(int tag)
           
 java.util.Date getDate(int tag)
           
 java.util.Date getDate(int tag, int index)
           
 java.util.Date[] getDateRange(int tag)
           
 java.util.Date[] getDates(int tag)
           
 java.util.Date getDateTime(int dateTag, int timeTag)
           
 java.util.Date[] getDateTimeRange(int dateTag, int timeTag)
           
 DcmHandler getDcmHandler()
           
 java.lang.Double getDouble(int tag)
           
 double getDouble(int tag, double defVal)
           
 java.lang.Double getDouble(int tag, int index)
           
 double getDouble(int tag, int index, double defVal)
           
 double[] getDoubles(int tag)
           
 java.lang.Float getFloat(int tag)
           
 float getFloat(int tag, float defVal)
           
 java.lang.Float getFloat(int tag, int index)
           
 float getFloat(int tag, int index, float defVal)
           
 float[] getFloats(int tag)
           
 int getInt(int tag, int defVal)
           
 int getInt(int tag, int index, int defVal)
           
 java.lang.Integer getInteger(int tag)
           
 java.lang.Integer getInteger(int tag, int index)
           
 int[] getInts(int tag)
           
 Dataset getItem(int tag)
           
 Dataset getItem(int tag, int index)
           
 PersonName getPersonName(int tag)
           
 PersonName getPersonName(int tag, int index)
           
 PersonName[] getPersonNames(int tag)
           
 java.lang.String getPrivateCreatorID()
           
 org.xml.sax.helpers.DefaultHandler getSAXHandler()
           
 org.xml.sax.helpers.DefaultHandler getSAXHandler2(java.io.File basedir)
           
 SpecificCharacterSet getSpecificCharacterSet()
           
 java.lang.String getString(int tag)
           
 java.lang.String getString(int tag, int index)
           
 java.lang.String getString(int tag, int index, java.lang.String defVal)
           
 java.lang.String getString(int tag, java.lang.String defVal)
           
 java.lang.String[] getStrings(int tag)
           
 int getTag(int tag, int defVal)
           
 int getTag(int tag, int index, int defVal)
           
 int[] getTags(int tag)
           
 boolean isEmpty()
           
 java.util.Iterator iterator()
           
 int length()
           
 DcmElement putAE(int tag)
           
 DcmElement putAE(int tag, java.lang.String value)
           
 DcmElement putAE(int tag, java.lang.String[] values)
           
 void putAll(DcmObject dcmObj)
           
 void putAll(DcmObject dcmObj, int itemTreatment)
           
 DcmElement putAS(int tag)
           
 DcmElement putAS(int tag, java.lang.String value)
           
 DcmElement putAS(int tag, java.lang.String[] values)
           
 DcmElement putAT(int tag)
           
 DcmElement putAT(int tag, int value)
           
 DcmElement putAT(int tag, int[] values)
           
 DcmElement putAT(int tag, java.lang.String value)
           
 DcmElement putAT(int tag, java.lang.String[] values)
           
 DcmElement putCS(int tag)
           
 DcmElement putCS(int tag, java.lang.String value)
           
 DcmElement putCS(int tag, java.lang.String[] values)
           
 DcmElement putDA(int tag)
           
 DcmElement putDA(int tag, java.util.Date value)
           
 DcmElement putDA(int tag, java.util.Date[] values)
           
 DcmElement putDA(int tag, java.util.Date from, java.util.Date to)
           
 DcmElement putDA(int tag, java.lang.String value)
           
 DcmElement putDA(int tag, java.lang.String[] values)
           
 DcmElement putDS(int tag)
           
 DcmElement putDS(int tag, float value)
           
 DcmElement putDS(int tag, float[] values)
           
 DcmElement putDS(int tag, java.lang.String value)
           
 DcmElement putDS(int tag, java.lang.String[] values)
           
 DcmElement putDT(int tag)
           
 DcmElement putDT(int tag, java.util.Date value)
           
 DcmElement putDT(int tag, java.util.Date[] values)
           
 DcmElement putDT(int tag, java.util.Date from, java.util.Date to)
           
 DcmElement putDT(int tag, java.lang.String value)
           
 DcmElement putDT(int tag, java.lang.String[] values)
           
 DcmElement putFD(int tag)
           
 DcmElement putFD(int tag, double value)
           
 DcmElement putFD(int tag, double[] values)
           
 DcmElement putFD(int tag, java.lang.String value)
           
 DcmElement putFD(int tag, java.lang.String[] values)
           
 DcmElement putFL(int tag)
           
 DcmElement putFL(int tag, float value)
           
 DcmElement putFL(int tag, float[] values)
           
 DcmElement putFL(int tag, java.lang.String value)
           
 DcmElement putFL(int tag, java.lang.String[] values)
           
 DcmElement putIS(int tag)
           
 DcmElement putIS(int tag, int value)
           
 DcmElement putIS(int tag, int[] values)
           
 DcmElement putIS(int tag, java.lang.String value)
           
 DcmElement putIS(int tag, java.lang.String[] values)
           
 DcmElement putLO(int tag)
           
 DcmElement putLO(int tag, java.lang.String value)
           
 DcmElement putLO(int tag, java.lang.String[] values)
           
 DcmElement putLT(int tag)
           
 DcmElement putLT(int tag, java.lang.String value)
           
 DcmElement putLT(int tag, java.lang.String[] values)
           
 DcmElement putOB(int tag)
           
 DcmElement putOB(int tag, byte[] value)
           
 DcmElement putOB(int tag, java.nio.ByteBuffer value)
           
 DcmElement putOBsq(int tag)
           
 DcmElement putOF(int tag)
           
 DcmElement putOF(int tag, java.nio.ByteBuffer value)
           
 DcmElement putOF(int tag, float[] value)
           
 DcmElement putOFsq(int tag)
           
 DcmElement putOW(int tag)
           
 DcmElement putOW(int tag, java.nio.ByteBuffer value)
           
 DcmElement putOW(int tag, short[] value)
           
 DcmElement putOWsq(int tag)
           
 DcmElement putPN(int tag)
           
 DcmElement putPN(int tag, PersonName value)
           
 DcmElement putPN(int tag, PersonName[] values)
           
 DcmElement putPN(int tag, java.lang.String value)
           
 DcmElement putPN(int tag, java.lang.String[] values)
           
 DcmElement putSH(int tag)
           
 DcmElement putSH(int tag, java.lang.String value)
           
 DcmElement putSH(int tag, java.lang.String[] values)
           
 DcmElement putSL(int tag)
           
 DcmElement putSL(int tag, int value)
           
 DcmElement putSL(int tag, int[] values)
           
 DcmElement putSL(int tag, java.lang.String value)
           
 DcmElement putSL(int tag, java.lang.String[] values)
           
 DcmElement putSQ(int tag)
           
 DcmElement putSS(int tag)
           
 DcmElement putSS(int tag, int value)
           
 DcmElement putSS(int tag, int[] values)
           
 DcmElement putSS(int tag, java.lang.String value)
           
 DcmElement putSS(int tag, java.lang.String[] values)
           
 DcmElement putST(int tag)
           
 DcmElement putST(int tag, java.lang.String value)
           
 DcmElement putST(int tag, java.lang.String[] values)
           
 DcmElement putTM(int tag)
           
 DcmElement putTM(int tag, java.util.Date value)
           
 DcmElement putTM(int tag, java.util.Date[] values)
           
 DcmElement putTM(int tag, java.util.Date from, java.util.Date to)
           
 DcmElement putTM(int tag, java.lang.String value)
           
 DcmElement putTM(int tag, java.lang.String[] values)
           
 DcmElement putUI(int tag)
           
 DcmElement putUI(int tag, java.lang.String value)
           
 DcmElement putUI(int tag, java.lang.String[] values)
           
 DcmElement putUL(int tag)
           
 DcmElement putUL(int tag, int value)
           
 DcmElement putUL(int tag, int[] values)
           
 DcmElement putUL(int tag, java.lang.String value)
           
 DcmElement putUL(int tag, java.lang.String[] values)
           
 DcmElement putUN(int tag)
           
 DcmElement putUN(int tag, byte[] value)
           
 DcmElement putUNsq(int tag)
           
 DcmElement putUS(int tag)
           
 DcmElement putUS(int tag, int value)
           
 DcmElement putUS(int tag, int[] values)
           
 DcmElement putUS(int tag, java.lang.String value)
           
 DcmElement putUS(int tag, java.lang.String[] values)
           
 DcmElement putUT(int tag)
           
 DcmElement putUT(int tag, java.lang.String value)
           
 DcmElement putUT(int tag, java.lang.String[] values)
           
 DcmElement putXX(int tag)
           
 DcmElement putXX(int tag, java.nio.ByteBuffer value)
           
 DcmElement putXX(int tag, int vr)
           
 DcmElement putXX(int tag, int vr, java.nio.ByteBuffer value)
           
 DcmElement putXX(int tag, int vr, java.lang.String value)
           
 DcmElement putXX(int tag, int vr, java.lang.String[] values)
           
 DcmElement putXX(int tag, java.lang.String value)
           
 DcmElement putXX(int tag, java.lang.String[] values)
           
 DcmElement putXXsq(int tag)
           
 DcmElement putXXsq(int tag, int vr)
           
 DcmElement remove(int tag)
           
 void setPrivateCreatorID(java.lang.String privateCreatorID)
           
 int size()
           
 int vm(int tag)
           
 void writeHeader(javax.imageio.stream.ImageOutputStream iout, DcmEncodeParam encParam, int tag, int vr, int len)
           
 void writeHeader(java.io.OutputStream out, DcmEncodeParam encParam, int tag, int vr, int len)
           
 

Field Detail

REPLACE_ITEMS

static final int REPLACE_ITEMS
Constant for itemTreatment param of @link {#putAll(dcmObj, int itemTreatment)}

See Also:
Constant Field Values

ADD_ITEMS

static final int ADD_ITEMS
Constant for itemTreatment param of @link {#putAll(dcmObj, int itemTreatment)}

See Also:
Constant Field Values

MERGE_ITEMS

static final int MERGE_ITEMS
Constant for itemTreatment param of @link {#putAll(dcmObj, int itemTreatment)}

See Also:
Constant Field Values
Method Detail

setPrivateCreatorID

void setPrivateCreatorID(java.lang.String privateCreatorID)

getPrivateCreatorID

java.lang.String getPrivateCreatorID()

getSpecificCharacterSet

SpecificCharacterSet getSpecificCharacterSet()

isEmpty

boolean isEmpty()

size

int size()

length

int length()

clear

void clear()

getDcmHandler

DcmHandler getDcmHandler()

getSAXHandler

org.xml.sax.helpers.DefaultHandler getSAXHandler()

getSAXHandler2

org.xml.sax.helpers.DefaultHandler getSAXHandler2(java.io.File basedir)

iterator

java.util.Iterator iterator()

contains

boolean contains(int tag)

containsValue

boolean containsValue(int tag)

vm

int vm(int tag)

get

DcmElement get(int tag)

remove

DcmElement remove(int tag)

getByteBuffer

java.nio.ByteBuffer getByteBuffer(int tag)

getString

java.lang.String getString(int tag)

getString

java.lang.String getString(int tag,
                           java.lang.String defVal)

getString

java.lang.String getString(int tag,
                           int index)

getString

java.lang.String getString(int tag,
                           int index,
                           java.lang.String defVal)

getStrings

java.lang.String[] getStrings(int tag)

getBoundedString

java.lang.String getBoundedString(int maxLen,
                                  int tag)

getBoundedString

java.lang.String getBoundedString(int maxLen,
                                  int tag,
                                  java.lang.String defVal)

getBoundedString

java.lang.String getBoundedString(int maxLen,
                                  int tag,
                                  int index)

getBoundedString

java.lang.String getBoundedString(int maxLen,
                                  int tag,
                                  int index,
                                  java.lang.String defVal)

getBoundedStrings

java.lang.String[] getBoundedStrings(int maxLen,
                                     int tag)

getPersonName

PersonName getPersonName(int tag)

getPersonNames

PersonName[] getPersonNames(int tag)

getPersonName

PersonName getPersonName(int tag,
                         int index)

getInteger

java.lang.Integer getInteger(int tag)

getInteger

java.lang.Integer getInteger(int tag,
                             int index)

getInt

int getInt(int tag,
           int defVal)

getInt

int getInt(int tag,
           int index,
           int defVal)

getInts

int[] getInts(int tag)

getTag

int getTag(int tag,
           int defVal)

getTag

int getTag(int tag,
           int index,
           int defVal)

getTags

int[] getTags(int tag)

getFloat

java.lang.Float getFloat(int tag)

getFloat

java.lang.Float getFloat(int tag,
                         int index)

getFloat

float getFloat(int tag,
               float defVal)

getFloat

float getFloat(int tag,
               int index,
               float defVal)

getFloats

float[] getFloats(int tag)

getDouble

java.lang.Double getDouble(int tag)

getDouble

java.lang.Double getDouble(int tag,
                           int index)

getDouble

double getDouble(int tag,
                 double defVal)

getDouble

double getDouble(int tag,
                 int index,
                 double defVal)

getDoubles

double[] getDoubles(int tag)

getDate

java.util.Date getDate(int tag)

getDate

java.util.Date getDate(int tag,
                       int index)

getDates

java.util.Date[] getDates(int tag)

getDateTime

java.util.Date getDateTime(int dateTag,
                           int timeTag)

getDateRange

java.util.Date[] getDateRange(int tag)

getDateTimeRange

java.util.Date[] getDateTimeRange(int dateTag,
                                  int timeTag)

getItem

Dataset getItem(int tag)

getItem

Dataset getItem(int tag,
                int index)

putAE

DcmElement putAE(int tag)

putAE

DcmElement putAE(int tag,
                 java.lang.String value)

putAE

DcmElement putAE(int tag,
                 java.lang.String[] values)

putAS

DcmElement putAS(int tag)

putAS

DcmElement putAS(int tag,
                 java.lang.String value)

putAS

DcmElement putAS(int tag,
                 java.lang.String[] values)

putAT

DcmElement putAT(int tag)

putAT

DcmElement putAT(int tag,
                 int value)

putAT

DcmElement putAT(int tag,
                 int[] values)

putAT

DcmElement putAT(int tag,
                 java.lang.String value)

putAT

DcmElement putAT(int tag,
                 java.lang.String[] values)

putCS

DcmElement putCS(int tag)

putCS

DcmElement putCS(int tag,
                 java.lang.String value)

putCS

DcmElement putCS(int tag,
                 java.lang.String[] values)

putDA

DcmElement putDA(int tag)

putDA

DcmElement putDA(int tag,
                 java.util.Date value)

putDA

DcmElement putDA(int tag,
                 java.util.Date[] values)

putDA

DcmElement putDA(int tag,
                 java.util.Date from,
                 java.util.Date to)

putDA

DcmElement putDA(int tag,
                 java.lang.String value)

putDA

DcmElement putDA(int tag,
                 java.lang.String[] values)

putDS

DcmElement putDS(int tag)

putDS

DcmElement putDS(int tag,
                 float value)

putDS

DcmElement putDS(int tag,
                 float[] values)

putDS

DcmElement putDS(int tag,
                 java.lang.String value)

putDS

DcmElement putDS(int tag,
                 java.lang.String[] values)

putDT

DcmElement putDT(int tag)

putDT

DcmElement putDT(int tag,
                 java.util.Date value)

putDT

DcmElement putDT(int tag,
                 java.util.Date[] values)

putDT

DcmElement putDT(int tag,
                 java.util.Date from,
                 java.util.Date to)

putDT

DcmElement putDT(int tag,
                 java.lang.String value)

putDT

DcmElement putDT(int tag,
                 java.lang.String[] values)

putFL

DcmElement putFL(int tag)

putFL

DcmElement putFL(int tag,
                 float value)

putFL

DcmElement putFL(int tag,
                 float[] values)

putFL

DcmElement putFL(int tag,
                 java.lang.String value)

putFL

DcmElement putFL(int tag,
                 java.lang.String[] values)

putFD

DcmElement putFD(int tag)

putFD

DcmElement putFD(int tag,
                 double value)

putFD

DcmElement putFD(int tag,
                 double[] values)

putFD

DcmElement putFD(int tag,
                 java.lang.String value)

putFD

DcmElement putFD(int tag,
                 java.lang.String[] values)

putIS

DcmElement putIS(int tag)

putIS

DcmElement putIS(int tag,
                 int value)

putIS

DcmElement putIS(int tag,
                 int[] values)

putIS

DcmElement putIS(int tag,
                 java.lang.String value)

putIS

DcmElement putIS(int tag,
                 java.lang.String[] values)

putLO

DcmElement putLO(int tag)

putLO

DcmElement putLO(int tag,
                 java.lang.String value)

putLO

DcmElement putLO(int tag,
                 java.lang.String[] values)

putLT

DcmElement putLT(int tag)

putLT

DcmElement putLT(int tag,
                 java.lang.String value)

putLT

DcmElement putLT(int tag,
                 java.lang.String[] values)

putOB

DcmElement putOB(int tag)

putOB

DcmElement putOB(int tag,
                 byte[] value)

putOB

DcmElement putOB(int tag,
                 java.nio.ByteBuffer value)

putOBsq

DcmElement putOBsq(int tag)

putOF

DcmElement putOF(int tag)

putOF

DcmElement putOF(int tag,
                 float[] value)

putOF

DcmElement putOF(int tag,
                 java.nio.ByteBuffer value)

putOFsq

DcmElement putOFsq(int tag)

putOW

DcmElement putOW(int tag)

putOW

DcmElement putOW(int tag,
                 short[] value)

putOW

DcmElement putOW(int tag,
                 java.nio.ByteBuffer value)

putOWsq

DcmElement putOWsq(int tag)

putPN

DcmElement putPN(int tag)

putPN

DcmElement putPN(int tag,
                 PersonName value)

putPN

DcmElement putPN(int tag,
                 PersonName[] values)

putPN

DcmElement putPN(int tag,
                 java.lang.String value)

putPN

DcmElement putPN(int tag,
                 java.lang.String[] values)

putSH

DcmElement putSH(int tag)

putSH

DcmElement putSH(int tag,
                 java.lang.String value)

putSH

DcmElement putSH(int tag,
                 java.lang.String[] values)

putSL

DcmElement putSL(int tag)

putSL

DcmElement putSL(int tag,
                 int value)

putSL

DcmElement putSL(int tag,
                 int[] values)

putSL

DcmElement putSL(int tag,
                 java.lang.String value)

putSL

DcmElement putSL(int tag,
                 java.lang.String[] values)

putSQ

DcmElement putSQ(int tag)

putSS

DcmElement putSS(int tag)

putSS

DcmElement putSS(int tag,
                 int value)

putSS

DcmElement putSS(int tag,
                 int[] values)

putSS

DcmElement putSS(int tag,
                 java.lang.String value)

putSS

DcmElement putSS(int tag,
                 java.lang.String[] values)

putST

DcmElement putST(int tag)

putST

DcmElement putST(int tag,
                 java.lang.String value)

putST

DcmElement putST(int tag,
                 java.lang.String[] values)

putTM

DcmElement putTM(int tag)

putTM

DcmElement putTM(int tag,
                 java.util.Date value)

putTM

DcmElement putTM(int tag,
                 java.util.Date[] values)

putTM

DcmElement putTM(int tag,
                 java.util.Date from,
                 java.util.Date to)

putTM

DcmElement putTM(int tag,
                 java.lang.String value)

putTM

DcmElement putTM(int tag,
                 java.lang.String[] values)

putUI

DcmElement putUI(int tag)

putUI

DcmElement putUI(int tag,
                 java.lang.String value)

putUI

DcmElement putUI(int tag,
                 java.lang.String[] values)

putUL

DcmElement putUL(int tag)

putUL

DcmElement putUL(int tag,
                 int value)

putUL

DcmElement putUL(int tag,
                 int[] values)

putUL

DcmElement putUL(int tag,
                 java.lang.String value)

putUL

DcmElement putUL(int tag,
                 java.lang.String[] values)

putUN

DcmElement putUN(int tag)

putUN

DcmElement putUN(int tag,
                 byte[] value)

putUNsq

DcmElement putUNsq(int tag)

putUS

DcmElement putUS(int tag)

putUS

DcmElement putUS(int tag,
                 int value)

putUS

DcmElement putUS(int tag,
                 int[] values)

putUS

DcmElement putUS(int tag,
                 java.lang.String value)

putUS

DcmElement putUS(int tag,
                 java.lang.String[] values)

putUT

DcmElement putUT(int tag)

putUT

DcmElement putUT(int tag,
                 java.lang.String value)

putUT

DcmElement putUT(int tag,
                 java.lang.String[] values)

putXX

DcmElement putXX(int tag,
                 int vr)

putXX

DcmElement putXX(int tag,
                 int vr,
                 java.nio.ByteBuffer value)

putXX

DcmElement putXX(int tag,
                 int vr,
                 java.lang.String value)

putXX

DcmElement putXX(int tag,
                 int vr,
                 java.lang.String[] values)

putXXsq

DcmElement putXXsq(int tag,
                   int vr)

putXX

DcmElement putXX(int tag)

putXX

DcmElement putXX(int tag,
                 java.nio.ByteBuffer value)

putXX

DcmElement putXX(int tag,
                 java.lang.String value)

putXX

DcmElement putXX(int tag,
                 java.lang.String[] values)

putXXsq

DcmElement putXXsq(int tag)

putAll

void putAll(DcmObject dcmObj)

putAll

void putAll(DcmObject dcmObj,
            int itemTreatment)

writeHeader

void writeHeader(java.io.OutputStream out,
                 DcmEncodeParam encParam,
                 int tag,
                 int vr,
                 int len)
                 throws java.io.IOException
Throws:
java.io.IOException

writeHeader

void writeHeader(javax.imageio.stream.ImageOutputStream iout,
                 DcmEncodeParam encParam,
                 int tag,
                 int vr,
                 int len)
                 throws java.io.IOException
Throws:
java.io.IOException