Package org.dcm4che.typeddicom.dataelements

Interface DICOMMediaRetrievalSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

InputInformationSequence.Item, OutputInformationSequence.Item, ReferencedPatientPhotoSequence.Item

Enclosing class:

DICOMMediaRetrievalSequence

public static interface DICOMMediaRetrievalSequence.Holder
extends org.dcm4che.typeddicom.AttributesWrapper

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DICOMMediaRetrievalSequence.Holder.Builder

Method Summary

Modifier and Type	Method	Description
static DICOMMediaRetrievalSequence.Holder.Builder	builder()
static DICOMMediaRetrievalSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDICOMMediaRetrievalSequence()
default DICOMMediaRetrievalSequence	ensureDICOMMediaRetrievalSequence()	Adds a new DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence) with initial capacity 1 (see ensureDICOMMediaRetrievalSequence(int)) if it does not already exist.
default DICOMMediaRetrievalSequence	ensureDICOMMediaRetrievalSequence(int initialCapacity)	Adds a new DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence) if it does not already exist.
default DICOMMediaRetrievalSequence	getDICOMMediaRetrievalSequence()
default DICOMMediaRetrievalSequence	newDICOMMediaRetrievalSequence(int initialCapacity)	Adds a new DICOM Media Retrieval Sequence.
default void	removeDICOMMediaRetrievalSequence()	Removes the DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence
static DICOMMediaRetrievalSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

static DICOMMediaRetrievalSequence.Holder wrap(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - an attributes object containing the DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence)

Returns:

a wrapper object implementing the DICOMMediaRetrievalSequence.Holder interface.

builder

static DICOMMediaRetrievalSequence.Holder.Builder builder()

Returns:

a DICOMMediaRetrievalSequence.Holder.Builder to create DICOM Media Retrieval Sequence Items with a fluent API.

builder

static DICOMMediaRetrievalSequence.Holder.Builder builder(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - the Attributes to be wrapped by the DICOMMediaRetrievalSequence.Holder.Builder.

Returns:

a DICOMMediaRetrievalSequence.Holder.Builder to create DICOM Media Retrieval Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getDICOMMediaRetrievalSequence

default DICOMMediaRetrievalSequence getDICOMMediaRetrievalSequence()

Returns:

the DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence)

newDICOMMediaRetrievalSequence

default DICOMMediaRetrievalSequence newDICOMMediaRetrievalSequence(int initialCapacity)

Adds a new DICOM Media Retrieval Sequence. (see DICOMMediaRetrievalSequence)

Parameters:

initialCapacity - the initial capacity for the new DICOM Media Retrieval Sequence

Returns:

the newly created DICOMMediaRetrievalSequence.

ensureDICOMMediaRetrievalSequence

default DICOMMediaRetrievalSequence ensureDICOMMediaRetrievalSequence(int initialCapacity)

Adds a new DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new DICOM Media Retrieval Sequence is created.

Returns:

either the already existing DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence) or a new one with capacity initialCapacity.

ensureDICOMMediaRetrievalSequence

default DICOMMediaRetrievalSequence ensureDICOMMediaRetrievalSequence()

Adds a new DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence) with initial capacity 1 (see ensureDICOMMediaRetrievalSequence(int)) if it does not already exist.

Returns:

either the already existing DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence) or a new one with capacity 1.

containsDICOMMediaRetrievalSequence

default boolean containsDICOMMediaRetrievalSequence()

Returns:

whether it contains the DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence)

removeDICOMMediaRetrievalSequence

default void removeDICOMMediaRetrievalSequence()

Removes the DICOM Media Retrieval Sequence (see DICOMMediaRetrievalSequence