Package org.dcm4che.typeddicom.dataelements

Interface MeasuredDoseReferenceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MeasuredDoseReferenceRecordModule

All Known Implementing Classes:

MeasuredDoseReferenceRecordModule.SimpleWrapper, RTBeamsTreatmentRecordIOD, RTBrachyTreatmentRecordIOD, RTIonBeamsTreatmentRecordIOD

Enclosing class:

MeasuredDoseReferenceSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MeasuredDoseReferenceSequence.Holder.Builder	builder()
static MeasuredDoseReferenceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsMeasuredDoseReferenceSequence()
default MeasuredDoseReferenceSequence	ensureMeasuredDoseReferenceSequence()	Adds a new Measured Dose Reference Sequence (see MeasuredDoseReferenceSequence) with initial capacity 1 (see ensureMeasuredDoseReferenceSequence(int)) if it does not already exist.
default MeasuredDoseReferenceSequence	ensureMeasuredDoseReferenceSequence(int initialCapacity)	Adds a new Measured Dose Reference Sequence (see MeasuredDoseReferenceSequence) if it does not already exist.
default MeasuredDoseReferenceSequence	getMeasuredDoseReferenceSequence()
default MeasuredDoseReferenceSequence	newMeasuredDoseReferenceSequence(int initialCapacity)	Adds a new Measured Dose Reference Sequence.
default void	removeMeasuredDoseReferenceSequence()	Removes the Measured Dose Reference Sequence (see MeasuredDoseReferenceSequence
static MeasuredDoseReferenceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Measured Dose Reference Sequence (see MeasuredDoseReferenceSequence)

Returns:

a wrapper object implementing the MeasuredDoseReferenceSequence.Holder interface.

builder

static MeasuredDoseReferenceSequence.Holder.Builder builder()

Returns:

a MeasuredDoseReferenceSequence.Holder.Builder to create Measured Dose Reference Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getMeasuredDoseReferenceSequence

default MeasuredDoseReferenceSequence getMeasuredDoseReferenceSequence()

Returns:

the Measured Dose Reference Sequence (see MeasuredDoseReferenceSequence)

newMeasuredDoseReferenceSequence

default MeasuredDoseReferenceSequence newMeasuredDoseReferenceSequence(int initialCapacity)

Adds a new Measured Dose Reference Sequence. (see MeasuredDoseReferenceSequence)

Parameters:

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

Returns:

the newly created MeasuredDoseReferenceSequence.

ensureMeasuredDoseReferenceSequence

default MeasuredDoseReferenceSequence ensureMeasuredDoseReferenceSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureMeasuredDoseReferenceSequence

default MeasuredDoseReferenceSequence ensureMeasuredDoseReferenceSequence()

Adds a new Measured Dose Reference Sequence (see MeasuredDoseReferenceSequence) with initial capacity 1 (see ensureMeasuredDoseReferenceSequence(int)) if it does not already exist.

Returns:

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

containsMeasuredDoseReferenceSequence

default boolean containsMeasuredDoseReferenceSequence()

Returns:

whether it contains the Measured Dose Reference Sequence (see MeasuredDoseReferenceSequence)

removeMeasuredDoseReferenceSequence

default void removeMeasuredDoseReferenceSequence()

Removes the Measured Dose Reference Sequence (see MeasuredDoseReferenceSequence