DICOMRetrievalSequence.Holder (dcm4che-typeddicom-lib API)

All Superinterfaces:: AttributesWrapper

All Known Implementing Classes:: InputInformationSequence.Item, OutputInformationSequence.Item, ReferencedPatientPhotoSequence.Item, ReferencedTextureSequence.Item

Enclosing class:: DICOMRetrievalSequence

public static interface DICOMRetrievalSequence.Holder extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "DICOM Retrieval Sequence" (see DICOMRetrievalSequence)

Method Summary

Modifier and Type

Method

Description

default boolean

containsDICOMRetrievalSequence()

default DICOMRetrievalSequence

ensureDICOMRetrievalSequence(int initialCapacity)

Adds a new DICOM Retrieval Sequence if it does not already exist.

default DICOMRetrievalSequence

getDICOMRetrievalSequence()

default DICOMRetrievalSequence

newDICOMRetrievalSequence(int initialCapacity)

Adds a new DICOM Retrieval Sequence.

default void

removeDICOMRetrievalSequence()

Removes the DICOM Retrieval Sequence (see DICOMRetrievalSequence

static DICOMRetrievalSequence.Holder

wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper
copy, getAttributes, isEmpty

Method Details
- wrap
  
  static DICOMRetrievalSequence.Holder wrap(org.dcm4che3.data.Attributes attributes)
  
  Parameters:
  
  attributes - An attributes object containing the DICOM Retrieval Sequence (see DICOMRetrievalSequence)
  
  Returns:
  
  A wrapper object implementing the DICOMRetrievalSequence.Holder interface.
- getDICOMRetrievalSequence
  
  default DICOMRetrievalSequence getDICOMRetrievalSequence()
  
  Returns:
  
  the DICOM Retrieval Sequence (see DICOMRetrievalSequence)
- newDICOMRetrievalSequence
  
  default DICOMRetrievalSequence newDICOMRetrievalSequence(int initialCapacity)
  
  Adds a new DICOM Retrieval Sequence. (see DICOMRetrievalSequence)
  
  Parameters:
  
  initialCapacity - the initial capacity for the new DICOM Retrieval Sequence
- ensureDICOMRetrievalSequence
  
  default DICOMRetrievalSequence ensureDICOMRetrievalSequence(int initialCapacity)
  
  Adds a new DICOM Retrieval Sequence if it does not already exist. (see DICOMRetrievalSequence)
  
  Parameters:
  
  initialCapacity - the initial capacity if a new DICOM Retrieval Sequence is created
- containsDICOMRetrievalSequence
  
  default boolean containsDICOMRetrievalSequence()
  
  Returns:
  
  Whether it contains the DICOM Retrieval Sequence (see DICOMRetrievalSequence)
- removeDICOMRetrievalSequence
  
  default void removeDICOMRetrievalSequence()
  
  Removes the DICOM Retrieval Sequence (see DICOMRetrievalSequence