Package org.dcm4che.typeddicom.dataelements

Interface ReferencedTreatmentRecordSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTDoseModule, RTGeneralTreatmentRecordModule

All Known Implementing Classes:

ReferencedTreatmentRecordSequence.SimpleHolder, RTBeamsTreatmentRecordIOD, RTBrachyTreatmentRecordIOD, RTDoseIOD, RTIonBeamsTreatmentRecordIOD, RTTreatmentSummaryRecordIOD

Enclosing class:

ReferencedTreatmentRecordSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Treatment Record Sequence" (see ReferencedTreatmentRecordSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedTreatmentRecordSequence.Holder.Builder	builder()
static ReferencedTreatmentRecordSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedTreatmentRecordSequence()
default ReferencedTreatmentRecordSequence	ensureReferencedTreatmentRecordSequence()	Adds a new Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence) with initial capacity 1 (see ensureReferencedTreatmentRecordSequence(int)) if it does not already exist.
default ReferencedTreatmentRecordSequence	ensureReferencedTreatmentRecordSequence(int initialCapacity)	Adds a new Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence) if it does not already exist.
default ReferencedTreatmentRecordSequence	getReferencedTreatmentRecordSequence()
default ReferencedTreatmentRecordSequence	newReferencedTreatmentRecordSequence(int initialCapacity)	Adds a new Referenced Treatment Record Sequence.
default void	removeReferencedTreatmentRecordSequence()	Removes the Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence
static ReferencedTreatmentRecordSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence)

Returns:

a wrapper object implementing the ReferencedTreatmentRecordSequence.Holder interface.

builder

static ReferencedTreatmentRecordSequence.Holder.Builder builder()

Returns:

a ReferencedTreatmentRecordSequence.Holder.Builder to create Referenced Treatment Record Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ReferencedTreatmentRecordSequence.Holder.Builder to create Referenced Treatment Record Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getReferencedTreatmentRecordSequence

default ReferencedTreatmentRecordSequence getReferencedTreatmentRecordSequence()

Returns:

the Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence)

newReferencedTreatmentRecordSequence

default ReferencedTreatmentRecordSequence newReferencedTreatmentRecordSequence(int initialCapacity)

Adds a new Referenced Treatment Record Sequence. (see ReferencedTreatmentRecordSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Treatment Record Sequence

Returns:

the newly created ReferencedTreatmentRecordSequence.

ensureReferencedTreatmentRecordSequence

default ReferencedTreatmentRecordSequence ensureReferencedTreatmentRecordSequence(int initialCapacity)

Adds a new Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence) or a new one with capacity initialCapacity.

ensureReferencedTreatmentRecordSequence

default ReferencedTreatmentRecordSequence ensureReferencedTreatmentRecordSequence()

Adds a new Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence) with initial capacity 1 (see ensureReferencedTreatmentRecordSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence) or a new one with capacity 1.

containsReferencedTreatmentRecordSequence

default boolean containsReferencedTreatmentRecordSequence()

Returns:

whether it contains the Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence)

removeReferencedTreatmentRecordSequence

default void removeReferencedTreatmentRecordSequence()

Removes the Referenced Treatment Record Sequence (see ReferencedTreatmentRecordSequence