Package org.dcm4che.typeddicom.dataelements

Interface ExposureSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTImageModule

All Known Implementing Classes:

RTImageIOD, RTImageModule.SimpleWrapper

Enclosing class:

ExposureSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ExposureSequence.Holder.Builder	builder()
static ExposureSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsExposureSequence()
default ExposureSequence	ensureExposureSequence()	Adds a new Exposure Sequence (see ExposureSequence) with initial capacity 1 (see ensureExposureSequence(int)) if it does not already exist.
default ExposureSequence	ensureExposureSequence(int initialCapacity)	Adds a new Exposure Sequence (see ExposureSequence) if it does not already exist.
default ExposureSequence	getExposureSequence()
default ExposureSequence	newExposureSequence(int initialCapacity)	Adds a new Exposure Sequence.
default void	removeExposureSequence()	Removes the Exposure Sequence (see ExposureSequence
static ExposureSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Exposure Sequence (see ExposureSequence)

Returns:

a wrapper object implementing the ExposureSequence.Holder interface.

builder

static ExposureSequence.Holder.Builder builder()

Returns:

a ExposureSequence.Holder.Builder to create Exposure Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getExposureSequence

default ExposureSequence getExposureSequence()

Returns:

the Exposure Sequence (see ExposureSequence)

newExposureSequence

default ExposureSequence newExposureSequence(int initialCapacity)

Adds a new Exposure Sequence. (see ExposureSequence)

Parameters:

initialCapacity - the initial capacity for the new Exposure Sequence

Returns:

the newly created ExposureSequence.

ensureExposureSequence

default ExposureSequence ensureExposureSequence(int initialCapacity)

Adds a new Exposure Sequence (see ExposureSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Exposure Sequence (see ExposureSequence) or a new one with capacity initialCapacity.

ensureExposureSequence

default ExposureSequence ensureExposureSequence()

Adds a new Exposure Sequence (see ExposureSequence) with initial capacity 1 (see ensureExposureSequence(int)) if it does not already exist.

Returns:

either the already existing Exposure Sequence (see ExposureSequence) or a new one with capacity 1.

containsExposureSequence

default boolean containsExposureSequence()

Returns:

whether it contains the Exposure Sequence (see ExposureSequence)

removeExposureSequence

default void removeExposureSequence()

Removes the Exposure Sequence (see ExposureSequence