Package org.dcm4che.typeddicom.dataelements

Interface ReferencedDoseReferenceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

BeamSequence.Item, ControlPointSequence.Item, FractionGroupSequence.Item, IonControlPointSequence.Item

Enclosing class:

ReferencedDoseReferenceSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedDoseReferenceSequence.Holder.Builder	builder()
static ReferencedDoseReferenceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedDoseReferenceSequence()
default ReferencedDoseReferenceSequence	ensureReferencedDoseReferenceSequence()	Adds a new Referenced Dose Reference Sequence (see ReferencedDoseReferenceSequence) with initial capacity 1 (see ensureReferencedDoseReferenceSequence(int)) if it does not already exist.
default ReferencedDoseReferenceSequence	ensureReferencedDoseReferenceSequence(int initialCapacity)	Adds a new Referenced Dose Reference Sequence (see ReferencedDoseReferenceSequence) if it does not already exist.
default ReferencedDoseReferenceSequence	getReferencedDoseReferenceSequence()
default ReferencedDoseReferenceSequence	newReferencedDoseReferenceSequence(int initialCapacity)	Adds a new Referenced Dose Reference Sequence.
default void	removeReferencedDoseReferenceSequence()	Removes the Referenced Dose Reference Sequence (see ReferencedDoseReferenceSequence
static ReferencedDoseReferenceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the ReferencedDoseReferenceSequence.Holder interface.

builder

static ReferencedDoseReferenceSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getReferencedDoseReferenceSequence

default ReferencedDoseReferenceSequence getReferencedDoseReferenceSequence()

Returns:

the Referenced Dose Reference Sequence (see ReferencedDoseReferenceSequence)

newReferencedDoseReferenceSequence

default ReferencedDoseReferenceSequence newReferencedDoseReferenceSequence(int initialCapacity)

Adds a new Referenced Dose Reference Sequence. (see ReferencedDoseReferenceSequence)

Parameters:

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

Returns:

the newly created ReferencedDoseReferenceSequence.

ensureReferencedDoseReferenceSequence

default ReferencedDoseReferenceSequence ensureReferencedDoseReferenceSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureReferencedDoseReferenceSequence

default ReferencedDoseReferenceSequence ensureReferencedDoseReferenceSequence()

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

Returns:

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

containsReferencedDoseReferenceSequence

default boolean containsReferencedDoseReferenceSequence()

Returns:

whether it contains the Referenced Dose Reference Sequence (see ReferencedDoseReferenceSequence)

removeReferencedDoseReferenceSequence

default void removeReferencedDoseReferenceSequence()

Removes the Referenced Dose Reference Sequence (see ReferencedDoseReferenceSequence