Package org.dcm4che.typeddicom.dataelements

Interface PhaseInformationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

NMPhaseModule

All Known Implementing Classes:

NMPhaseModule.SimpleWrapper, NuclearMedicineImageIOD

Enclosing class:

PhaseInformationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Phase Information Sequence" (see PhaseInformationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PhaseInformationSequence.Holder.Builder	builder()
static PhaseInformationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPhaseInformationSequence()
default PhaseInformationSequence	ensurePhaseInformationSequence()	Adds a new Phase Information Sequence (see PhaseInformationSequence) with initial capacity 1 (see ensurePhaseInformationSequence(int)) if it does not already exist.
default PhaseInformationSequence	ensurePhaseInformationSequence(int initialCapacity)	Adds a new Phase Information Sequence (see PhaseInformationSequence) if it does not already exist.
default PhaseInformationSequence	getPhaseInformationSequence()
default PhaseInformationSequence	newPhaseInformationSequence(int initialCapacity)	Adds a new Phase Information Sequence.
default void	removePhaseInformationSequence()	Removes the Phase Information Sequence (see PhaseInformationSequence
static PhaseInformationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Phase Information Sequence (see PhaseInformationSequence)

Returns:

a wrapper object implementing the PhaseInformationSequence.Holder interface.

builder

static PhaseInformationSequence.Holder.Builder builder()

Returns:

a PhaseInformationSequence.Holder.Builder to create Phase Information Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPhaseInformationSequence

default PhaseInformationSequence getPhaseInformationSequence()

Returns:

the Phase Information Sequence (see PhaseInformationSequence)

newPhaseInformationSequence

default PhaseInformationSequence newPhaseInformationSequence(int initialCapacity)

Adds a new Phase Information Sequence. (see PhaseInformationSequence)

Parameters:

initialCapacity - the initial capacity for the new Phase Information Sequence

Returns:

the newly created PhaseInformationSequence.

ensurePhaseInformationSequence

default PhaseInformationSequence ensurePhaseInformationSequence(int initialCapacity)

Adds a new Phase Information Sequence (see PhaseInformationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Phase Information Sequence (see PhaseInformationSequence) or a new one with capacity initialCapacity.

ensurePhaseInformationSequence

default PhaseInformationSequence ensurePhaseInformationSequence()

Adds a new Phase Information Sequence (see PhaseInformationSequence) with initial capacity 1 (see ensurePhaseInformationSequence(int)) if it does not already exist.

Returns:

either the already existing Phase Information Sequence (see PhaseInformationSequence) or a new one with capacity 1.

containsPhaseInformationSequence

default boolean containsPhaseInformationSequence()

Returns:

whether it contains the Phase Information Sequence (see PhaseInformationSequence)

removePhaseInformationSequence

default void removePhaseInformationSequence()

Removes the Phase Information Sequence (see PhaseInformationSequence