Package org.dcm4che.typeddicom.dataelements

Interface DosimetricObjectiveSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTEnhancedPrescriptionModule

All Known Implementing Classes:

RTEnhancedPrescriptionModule.SimpleWrapper, RTPhysicianIntentIOD

Enclosing class:

DosimetricObjectiveSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Dosimetric Objective Sequence" (see DosimetricObjectiveSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DosimetricObjectiveSequence.Holder.Builder	builder()
static DosimetricObjectiveSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDosimetricObjectiveSequence()
default DosimetricObjectiveSequence	ensureDosimetricObjectiveSequence()	Adds a new Dosimetric Objective Sequence (see DosimetricObjectiveSequence) with initial capacity 1 (see ensureDosimetricObjectiveSequence(int)) if it does not already exist.
default DosimetricObjectiveSequence	ensureDosimetricObjectiveSequence(int initialCapacity)	Adds a new Dosimetric Objective Sequence (see DosimetricObjectiveSequence) if it does not already exist.
default DosimetricObjectiveSequence	getDosimetricObjectiveSequence()
default DosimetricObjectiveSequence	newDosimetricObjectiveSequence(int initialCapacity)	Adds a new Dosimetric Objective Sequence.
default void	removeDosimetricObjectiveSequence()	Removes the Dosimetric Objective Sequence (see DosimetricObjectiveSequence
static DosimetricObjectiveSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Dosimetric Objective Sequence (see DosimetricObjectiveSequence)

Returns:

a wrapper object implementing the DosimetricObjectiveSequence.Holder interface.

builder

static DosimetricObjectiveSequence.Holder.Builder builder()

Returns:

a DosimetricObjectiveSequence.Holder.Builder to create Dosimetric Objective Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a DosimetricObjectiveSequence.Holder.Builder to create Dosimetric Objective Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getDosimetricObjectiveSequence

default DosimetricObjectiveSequence getDosimetricObjectiveSequence()

Returns:

the Dosimetric Objective Sequence (see DosimetricObjectiveSequence)

newDosimetricObjectiveSequence

default DosimetricObjectiveSequence newDosimetricObjectiveSequence(int initialCapacity)

Adds a new Dosimetric Objective Sequence. (see DosimetricObjectiveSequence)

Parameters:

initialCapacity - the initial capacity for the new Dosimetric Objective Sequence

Returns:

the newly created DosimetricObjectiveSequence.

ensureDosimetricObjectiveSequence

default DosimetricObjectiveSequence ensureDosimetricObjectiveSequence(int initialCapacity)

Adds a new Dosimetric Objective Sequence (see DosimetricObjectiveSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Dosimetric Objective Sequence (see DosimetricObjectiveSequence) or a new one with capacity initialCapacity.

ensureDosimetricObjectiveSequence

default DosimetricObjectiveSequence ensureDosimetricObjectiveSequence()

Adds a new Dosimetric Objective Sequence (see DosimetricObjectiveSequence) with initial capacity 1 (see ensureDosimetricObjectiveSequence(int)) if it does not already exist.

Returns:

either the already existing Dosimetric Objective Sequence (see DosimetricObjectiveSequence) or a new one with capacity 1.

containsDosimetricObjectiveSequence

default boolean containsDosimetricObjectiveSequence()

Returns:

whether it contains the Dosimetric Objective Sequence (see DosimetricObjectiveSequence)

removeDosimetricObjectiveSequence

default void removeDosimetricObjectiveSequence()

Removes the Dosimetric Objective Sequence (see DosimetricObjectiveSequence