Skip navigation links

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

E17343-02


oracle.ord.dicom.client
Class DicomLocatorService

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


public final class DicomLocatorService
extends DicomService

The DicomLocatorService class extends the DicomService class to provide services to extract DICOM metadata using DICOM value locators. DICOM value locators are defined by Oracle Multimedia. See Oracle Multimedia DICOM Developer's Guide for more information about DICOM value locators. A DicomLocatorService object is created by specifying a list of DICOM value locators.


Field Summary

 

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

 

Constructor Summary
DicomLocatorService(java.lang.String[] locators)
          Constructs a DicomLocatorService object with the specified DICOM value locators.

 

Method Summary
 java.lang.String[] getFirstAttrs(java.io.File file, java.util.Map<java.lang.String,java.lang.Throwable> errors)
          Extracts the value of the first attribute for each DICOM value locator from the input DICOM file.
 java.lang.String[] getFirstAttrs(java.io.InputStream instr, java.util.Map<java.lang.String,java.lang.Throwable> errors)
          Extracts the value of the first attribute for each DICOM value locator from the DICOM InputStream object.
 java.lang.String[] getLocators()
          Returns the DICOM value locators used to construct this DicomLocatorService object.

 

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

 

Constructor Detail

DicomLocatorService

public DicomLocatorService(java.lang.String[] locators)
                    throws DicomServiceException
Constructs a DicomLocatorService object with the specified DICOM value locators.
Parameters:
locators - an array of DICOM value locators defined by Oracle Multimedia.
Throws:
DicomServiceException - if the input array of value locators is null, a data model error occurs, or any of the value locators are invalid or nonscalar. Value locators are invalid when they do not conform to the required syntax. Value locators are nonscalar when the last attribute tag is specified as type SQ, UN, OW, OF, or OB.

Method Detail

getFirstAttrs

public java.lang.String[] getFirstAttrs(java.io.InputStream instr,
                                        java.util.Map<java.lang.String,java.lang.Throwable> errors)
                                 throws DicomServiceException,
                                        java.io.IOException
Extracts the value of the first attribute for each DICOM value locator 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 the value 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 String array of DICOM attribute values. Each string represents the first attribute value of each value locator. If a value locator does not exist in the InputStream object, the corresponding String in the array is null.
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.

getFirstAttrs

public java.lang.String[] getFirstAttrs(java.io.File file,
                                        java.util.Map<java.lang.String,java.lang.Throwable> errors)
                                 throws DicomServiceException,
                                        java.io.IOException
Extracts the value of the first attribute for each DICOM value locator 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 the value 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 String array of DICOM attribute values. Each string represents the first attribute value of each value locator. If a value locator does not exist in the InputStream object, the corresponding String in the array is null.
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.

getLocators

public java.lang.String[] getLocators()
Returns the DICOM value locators used to construct this DicomLocatorService object.
Returns:
an array of DICOM value locators used to construct this DicomLocatorService 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.