Package org.dcm4che.typeddicom.dataelements

Interface RadiationDoseSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTDoseContributionModule, RTDoseContributionRecordModule

All Known Implementing Classes:

RadiationDoseSequence.SimpleHolder, RTRadiationRecordSetIOD, RTRadiationSetIOD

Enclosing class:

RadiationDoseSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RadiationDoseSequence.Holder.Builder	builder()
static RadiationDoseSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRadiationDoseSequence()
default RadiationDoseSequence	ensureRadiationDoseSequence()	Adds a new Radiation Dose Sequence (see RadiationDoseSequence) with initial capacity 1 (see ensureRadiationDoseSequence(int)) if it does not already exist.
default RadiationDoseSequence	ensureRadiationDoseSequence(int initialCapacity)	Adds a new Radiation Dose Sequence (see RadiationDoseSequence) if it does not already exist.
default RadiationDoseSequence	getRadiationDoseSequence()
default RadiationDoseSequence	newRadiationDoseSequence(int initialCapacity)	Adds a new Radiation Dose Sequence.
default void	removeRadiationDoseSequence()	Removes the Radiation Dose Sequence (see RadiationDoseSequence
static RadiationDoseSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Radiation Dose Sequence (see RadiationDoseSequence)

Returns:

a wrapper object implementing the RadiationDoseSequence.Holder interface.

builder

static RadiationDoseSequence.Holder.Builder builder()

Returns:

a RadiationDoseSequence.Holder.Builder to create Radiation Dose Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRadiationDoseSequence

default RadiationDoseSequence getRadiationDoseSequence()

Returns:

the Radiation Dose Sequence (see RadiationDoseSequence)

newRadiationDoseSequence

default RadiationDoseSequence newRadiationDoseSequence(int initialCapacity)

Adds a new Radiation Dose Sequence. (see RadiationDoseSequence)

Parameters:

initialCapacity - the initial capacity for the new Radiation Dose Sequence

Returns:

the newly created RadiationDoseSequence.

ensureRadiationDoseSequence

default RadiationDoseSequence ensureRadiationDoseSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureRadiationDoseSequence

default RadiationDoseSequence ensureRadiationDoseSequence()

Adds a new Radiation Dose Sequence (see RadiationDoseSequence) with initial capacity 1 (see ensureRadiationDoseSequence(int)) if it does not already exist.

Returns:

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

containsRadiationDoseSequence

default boolean containsRadiationDoseSequence()

Returns:

whether it contains the Radiation Dose Sequence (see RadiationDoseSequence)

removeRadiationDoseSequence

default void removeRadiationDoseSequence()

Removes the Radiation Dose Sequence (see RadiationDoseSequence