Package org.dcm4che.typeddicom.dataelements

Interface DerivationImageSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

CurrentFrameFunctionalGroupsSequence.Item, DerivationImageSequence.SimpleHolder, PerFrameFunctionalGroupsSequence.Item, SharedFunctionalGroupsSequence.Item

Enclosing class:

DerivationImageSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Derivation Image Sequence" (see DerivationImageSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DerivationImageSequence.Holder.Builder	builder()
static DerivationImageSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDerivationImageSequence()
default DerivationImageSequence	ensureDerivationImageSequence()	Adds a new Derivation Image Sequence (see DerivationImageSequence) with initial capacity 1 (see ensureDerivationImageSequence(int)) if it does not already exist.
default DerivationImageSequence	ensureDerivationImageSequence(int initialCapacity)	Adds a new Derivation Image Sequence (see DerivationImageSequence) if it does not already exist.
default DerivationImageSequence	getDerivationImageSequence()
default DerivationImageSequence	newDerivationImageSequence(int initialCapacity)	Adds a new Derivation Image Sequence.
default void	removeDerivationImageSequence()	Removes the Derivation Image Sequence (see DerivationImageSequence
static DerivationImageSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Derivation Image Sequence (see DerivationImageSequence)

Returns:

a wrapper object implementing the DerivationImageSequence.Holder interface.

builder

static DerivationImageSequence.Holder.Builder builder()

Returns:

a DerivationImageSequence.Holder.Builder to create Derivation Image Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDerivationImageSequence

default DerivationImageSequence getDerivationImageSequence()

Returns:

the Derivation Image Sequence (see DerivationImageSequence)

newDerivationImageSequence

default DerivationImageSequence newDerivationImageSequence(int initialCapacity)

Adds a new Derivation Image Sequence. (see DerivationImageSequence)

Parameters:

initialCapacity - the initial capacity for the new Derivation Image Sequence

Returns:

the newly created DerivationImageSequence.

ensureDerivationImageSequence

default DerivationImageSequence ensureDerivationImageSequence(int initialCapacity)

Adds a new Derivation Image Sequence (see DerivationImageSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Derivation Image Sequence (see DerivationImageSequence) or a new one with capacity initialCapacity.

ensureDerivationImageSequence

default DerivationImageSequence ensureDerivationImageSequence()

Adds a new Derivation Image Sequence (see DerivationImageSequence) with initial capacity 1 (see ensureDerivationImageSequence(int)) if it does not already exist.

Returns:

either the already existing Derivation Image Sequence (see DerivationImageSequence) or a new one with capacity 1.

containsDerivationImageSequence

default boolean containsDerivationImageSequence()

Returns:

whether it contains the Derivation Image Sequence (see DerivationImageSequence)

removeDerivationImageSequence

default void removeDerivationImageSequence()

Removes the Derivation Image Sequence (see DerivationImageSequence