Skip navigation links

Oracle® Multimedia Mid-Tier Java API Reference
11g Release 2 (11.2)

E17343-02


oracle.ord.dicom.client
Class DicomTagService

java.lang.Object
  extended by oracle.ord.dicom.client.DicomService
      extended by oracle.ord.dicom.client.DicomTagService


public final class DicomTagService
extends DicomService

The DicomTagService class extends the DicomService class to provide services to extract DICOM metadata using DICOM attribute tags. DICOM attribute tags are defined by the DICOM standard. A DicomTagService object is created by specifying a list of DICOM attribute tags.


Field Summary

 

Fields inherited from class oracle.ord.dicom.client.DicomService
IGNORE_ERROR, THROW_EXCEPTION

 

Constructor Summary
DicomTagService(java.lang.String[] attrTags)
          Constructs a DicomTagService Object with the specified DICOM attribute tags.

 

Method Summary
 java.util.List<java.lang.String>[] getAttrs(java.io.File file, java.util.Map<java.lang.String,java.lang.Throwable> errors)
          Extracts the values of the DICOM attribute for each attribute tag from the input DICOM file.
 java.util.List<java.lang.String>[] getAttrs(java.io.InputStream instr, java.util.Map<java.lang.String,java.lang.Throwable> errors)
          Extracts the values of the DICOM attribute for each attribute tag from the DICOM InputStream object.
 java.lang.String[] getAttrTags()
          Returns the DICOM attribute tags used to construct this DicomTagService object.

 

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

 

Constructor Detail

DicomTagService

public DicomTagService(java.lang.String[] attrTags)
                throws DicomServiceException
Constructs a DicomTagService Object with the specified DICOM attribute tags.
Parameters:
attrTags - an array of DICOM attribute tags. Attribute tags must specify root-level attributes only. Attribute tags cannot be specified as the following DICOM types: SQ, UN, OW, OF, or OB. An attribute tag must be specified as a string in one of the following formats: "ggggeeee", "ggggeeee[n]", or "ggggeeee[*]"; where gggg is the DICOM group number, eeee is the DICOM element number, and n is a positive integer.
Throws:
DicomServiceException - if the input array of attribute tags is null, a data model error occurs, or any of the attribute tags are invalid or nonscalar. Attribute tags are invalid when they do not conform to the required syntax. Attribute tags are nonscalar when they are specified as type SQ, UN, OW, OF, or OB.

Method Detail

getAttrs

public java.util.List<java.lang.String>[] getAttrs(java.io.InputStream instr,
                                                   java.util.Map<java.lang.String,java.lang.Throwable> errors)
                                            throws DicomServiceException,
                                                   java.io.IOException
Extracts the values of the DICOM attribute for each attribute tag from the DICOM InputStream object.
Parameters:
instr - an InputStream object that contains DICOM data.
errors - a Map object used to store errors that occurred during execution. Execution errors are stored in this object using the DICOM value locators that caused the errors as keys and the corresponding Throwable objects as values. If this object is null, execution errors are ignored. Use the predefined Map DicomService.IGNORE_ERROR to ignore execution errors, or use the Map DicomService.THROW_EXCEPTION to throw an exception when the first error occurs.
Returns:
a List array. Each list contains the DICOM string attribute value or the values for each attribute tag. If the attribute tag is "ggggeeee", the corresponding List in the array contains the first attribute value. If the attribute tag is "ggggeeee[n]", the corresponding List in the array contains the n-th attribute value. If the attribute tag is "ggggeeee[*]", the corresponding List in the array contains all the attribute values. If the attribute tag points to an attribute that does not exist in the InputStream object, the corresponding List in the array is empty. If the attribute tag points to an attribute that is not a root-level attribute, the corresponding List in the array is empty.
Throws:
DicomServiceException - if the InputStream object is null, or if it contains invalid DICOM data.
java.io.IOException - if an error occurs opening or reading the InputStream object.

getAttrs

public java.util.List<java.lang.String>[] getAttrs(java.io.File file,
                                                   java.util.Map<java.lang.String,java.lang.Throwable> errors)
                                            throws DicomServiceException,
                                                   java.io.IOException
Extracts the values of the DICOM attribute for each attribute tag from the input DICOM file.
Parameters:
file - a File object that contains DICOM data.
errors - a Map object used to store errors that occurred during execution. Execution errors are stored in this object using the DICOM value locators that caused the errors as keys and the corresponding Throwable objects as values. If this object is null, execution errors are ignored. Use the predefined Map DicomService.IGNORE_ERROR to ignore execution errors, or use the Map DicomService.THROW_EXCEPTION to throw an exception when the first error occurs.
Returns:
a List array. Each list contains the DICOM string attribute value or the values for each attribute tag. If the attribute tag is "ggggeeee", the corresponding List in the array contains the first attribute value. If the attribute tag is "ggggeeee[n]", the corresponding List in the array contains the n-th attribute value. If the attribute tag is "ggggeeee[*]", the corresponding List in the array contains all the attribute values. If the attribute tag points to an attribute that does not exist in the InputStream object, the corresponding List in the array is empty. If the attribute tag points to an attribute that is not a root-level attribute, the corresponding List in the array is empty.
Throws:
DicomServiceException - if the File object is null, or if it contains invalid DICOM data.
java.io.IOException - if an error occurs opening or reading the File object.

getAttrTags

public java.lang.String[] getAttrTags()
Returns the DICOM attribute tags used to construct this DicomTagService object.
Returns:
an array of DICOM attribute tags used to construct this DicomTagService object.

Skip navigation links

Oracle® Multimedia Mid-Tier Java API Reference
11g Release 2 (11.2)

E17343-02


Copyright © 2008, 2010, Oracle and/or its affiliates. All rights reserved.