Package org.dcm4che.typeddicom.dataelements

Interface DoseReferenceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTPrescriptionModule

All Known Implementing Classes:

RTIonPlanIOD, RTPlanIOD, RTPrescriptionModule.SimpleWrapper

Enclosing class:

DoseReferenceSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DoseReferenceSequence.Holder.Builder	builder()
static DoseReferenceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDoseReferenceSequence()
default DoseReferenceSequence	ensureDoseReferenceSequence()	Adds a new Dose Reference Sequence (see DoseReferenceSequence) with initial capacity 1 (see ensureDoseReferenceSequence(int)) if it does not already exist.
default DoseReferenceSequence	ensureDoseReferenceSequence(int initialCapacity)	Adds a new Dose Reference Sequence (see DoseReferenceSequence) if it does not already exist.
default DoseReferenceSequence	getDoseReferenceSequence()
default DoseReferenceSequence	newDoseReferenceSequence(int initialCapacity)	Adds a new Dose Reference Sequence.
default void	removeDoseReferenceSequence()	Removes the Dose Reference Sequence (see DoseReferenceSequence
static DoseReferenceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the DoseReferenceSequence.Holder interface.

builder

static DoseReferenceSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getDoseReferenceSequence

default DoseReferenceSequence getDoseReferenceSequence()

Returns:

the Dose Reference Sequence (see DoseReferenceSequence)

newDoseReferenceSequence

default DoseReferenceSequence newDoseReferenceSequence(int initialCapacity)

Adds a new Dose Reference Sequence. (see DoseReferenceSequence)

Parameters:

initialCapacity - the initial capacity for the new Dose Reference Sequence

Returns:

the newly created DoseReferenceSequence.

ensureDoseReferenceSequence

default DoseReferenceSequence ensureDoseReferenceSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureDoseReferenceSequence

default DoseReferenceSequence ensureDoseReferenceSequence()

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

Returns:

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

containsDoseReferenceSequence

default boolean containsDoseReferenceSequence()

Returns:

whether it contains the Dose Reference Sequence (see DoseReferenceSequence)

removeDoseReferenceSequence

default void removeDoseReferenceSequence()

Removes the Dose Reference Sequence (see DoseReferenceSequence