Package org.dcm4che.typeddicom.dataelements

Interface ReferencedDoseSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTGeneralPlanModule

All Known Implementing Classes:

BeamSequence.Item, ControlPointSequence.Item, FractionGroupSequence.Item, IonBeamSequence.Item, ReferencedDoseSequence.SimpleHolder, RTIonPlanIOD, RTPlanIOD

Enclosing class:

ReferencedDoseSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Dose Sequence" (see ReferencedDoseSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedDoseSequence.Holder.Builder	builder()
static ReferencedDoseSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedDoseSequence()
default ReferencedDoseSequence	ensureReferencedDoseSequence()	Adds a new Referenced Dose Sequence (see ReferencedDoseSequence) with initial capacity 1 (see ensureReferencedDoseSequence(int)) if it does not already exist.
default ReferencedDoseSequence	ensureReferencedDoseSequence(int initialCapacity)	Adds a new Referenced Dose Sequence (see ReferencedDoseSequence) if it does not already exist.
default ReferencedDoseSequence	getReferencedDoseSequence()
default ReferencedDoseSequence	newReferencedDoseSequence(int initialCapacity)	Adds a new Referenced Dose Sequence.
default void	removeReferencedDoseSequence()	Removes the Referenced Dose Sequence (see ReferencedDoseSequence
static ReferencedDoseSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Dose Sequence (see ReferencedDoseSequence)

Returns:

a wrapper object implementing the ReferencedDoseSequence.Holder interface.

builder

static ReferencedDoseSequence.Holder.Builder builder()

Returns:

a ReferencedDoseSequence.Holder.Builder to create Referenced Dose Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedDoseSequence

default ReferencedDoseSequence getReferencedDoseSequence()

Returns:

the Referenced Dose Sequence (see ReferencedDoseSequence)

newReferencedDoseSequence

default ReferencedDoseSequence newReferencedDoseSequence(int initialCapacity)

Adds a new Referenced Dose Sequence. (see ReferencedDoseSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Dose Sequence

Returns:

the newly created ReferencedDoseSequence.

ensureReferencedDoseSequence

default ReferencedDoseSequence ensureReferencedDoseSequence(int initialCapacity)

Adds a new Referenced Dose Sequence (see ReferencedDoseSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced Dose Sequence (see ReferencedDoseSequence) or a new one with capacity initialCapacity.

ensureReferencedDoseSequence

default ReferencedDoseSequence ensureReferencedDoseSequence()

Adds a new Referenced Dose Sequence (see ReferencedDoseSequence) with initial capacity 1 (see ensureReferencedDoseSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced Dose Sequence (see ReferencedDoseSequence) or a new one with capacity 1.

containsReferencedDoseSequence

default boolean containsReferencedDoseSequence()

Returns:

whether it contains the Referenced Dose Sequence (see ReferencedDoseSequence)

removeReferencedDoseSequence

default void removeReferencedDoseSequence()

Removes the Referenced Dose Sequence (see ReferencedDoseSequence