Package org.dcm4che.typeddicom.dataelements

Interface DICOMRetrievalSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

InputInformationSequence.Item, OutputInformationSequence.Item, ReferencedPatientPhotoSequence.Item

Enclosing class:

DICOMRetrievalSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DICOMRetrievalSequence.Holder.Builder	builder()
static DICOMRetrievalSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDICOMRetrievalSequence()
default DICOMRetrievalSequence	ensureDICOMRetrievalSequence()	Adds a new DICOM Retrieval Sequence (see DICOMRetrievalSequence) with initial capacity 1 (see ensureDICOMRetrievalSequence(int)) if it does not already exist.
default DICOMRetrievalSequence	ensureDICOMRetrievalSequence(int initialCapacity)	Adds a new DICOM Retrieval Sequence (see DICOMRetrievalSequence) 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, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

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.

builder

static DICOMRetrievalSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

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

Returns:

the newly created DICOMRetrievalSequence.

ensureDICOMRetrievalSequence

default DICOMRetrievalSequence ensureDICOMRetrievalSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureDICOMRetrievalSequence

default DICOMRetrievalSequence ensureDICOMRetrievalSequence()

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

Returns:

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

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