Package org.dcm4che.typeddicom.dataelements

Interface CalculatedDoseReferenceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

CalculatedDoseReferenceRecordModule

All Known Implementing Classes:

CalculatedDoseReferenceRecordModule.SimpleWrapper, RTBeamsTreatmentRecordIOD, RTBrachyTreatmentRecordIOD, RTIonBeamsTreatmentRecordIOD

Enclosing class:

CalculatedDoseReferenceSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Calculated Dose Reference Sequence" (see CalculatedDoseReferenceSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CalculatedDoseReferenceSequence.Holder.Builder	builder()
static CalculatedDoseReferenceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsCalculatedDoseReferenceSequence()
default CalculatedDoseReferenceSequence	ensureCalculatedDoseReferenceSequence()	Adds a new Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence) with initial capacity 1 (see ensureCalculatedDoseReferenceSequence(int)) if it does not already exist.
default CalculatedDoseReferenceSequence	ensureCalculatedDoseReferenceSequence(int initialCapacity)	Adds a new Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence) if it does not already exist.
default CalculatedDoseReferenceSequence	getCalculatedDoseReferenceSequence()
default CalculatedDoseReferenceSequence	newCalculatedDoseReferenceSequence(int initialCapacity)	Adds a new Calculated Dose Reference Sequence.
default void	removeCalculatedDoseReferenceSequence()	Removes the Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence
static CalculatedDoseReferenceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence)

Returns:

a wrapper object implementing the CalculatedDoseReferenceSequence.Holder interface.

builder

static CalculatedDoseReferenceSequence.Holder.Builder builder()

Returns:

a CalculatedDoseReferenceSequence.Holder.Builder to create Calculated Dose Reference Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getCalculatedDoseReferenceSequence

default CalculatedDoseReferenceSequence getCalculatedDoseReferenceSequence()

Returns:

the Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence)

newCalculatedDoseReferenceSequence

default CalculatedDoseReferenceSequence newCalculatedDoseReferenceSequence(int initialCapacity)

Adds a new Calculated Dose Reference Sequence. (see CalculatedDoseReferenceSequence)

Parameters:

initialCapacity - the initial capacity for the new Calculated Dose Reference Sequence

Returns:

the newly created CalculatedDoseReferenceSequence.

ensureCalculatedDoseReferenceSequence

default CalculatedDoseReferenceSequence ensureCalculatedDoseReferenceSequence(int initialCapacity)

Adds a new Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence) or a new one with capacity initialCapacity.

ensureCalculatedDoseReferenceSequence

default CalculatedDoseReferenceSequence ensureCalculatedDoseReferenceSequence()

Adds a new Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence) with initial capacity 1 (see ensureCalculatedDoseReferenceSequence(int)) if it does not already exist.

Returns:

either the already existing Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence) or a new one with capacity 1.

containsCalculatedDoseReferenceSequence

default boolean containsCalculatedDoseReferenceSequence()

Returns:

whether it contains the Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence)

removeCalculatedDoseReferenceSequence

default void removeCalculatedDoseReferenceSequence()

Removes the Calculated Dose Reference Sequence (see CalculatedDoseReferenceSequence