Package org.dcm4che.typeddicom.dataelements

Interface FractionGroupSummarySequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTTreatmentSummaryRecordModule

All Known Implementing Classes:

RTBeamsTreatmentRecordIOD, RTBrachyTreatmentRecordIOD, RTIonBeamsTreatmentRecordIOD, RTTreatmentSummaryRecordIOD, RTTreatmentSummaryRecordModule.SimpleWrapper

Enclosing class:

FractionGroupSummarySequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Fraction Group Summary Sequence" (see FractionGroupSummarySequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FractionGroupSummarySequence.Holder.Builder	builder()
static FractionGroupSummarySequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFractionGroupSummarySequence()
default FractionGroupSummarySequence	ensureFractionGroupSummarySequence()	Adds a new Fraction Group Summary Sequence (see FractionGroupSummarySequence) with initial capacity 1 (see ensureFractionGroupSummarySequence(int)) if it does not already exist.
default FractionGroupSummarySequence	ensureFractionGroupSummarySequence(int initialCapacity)	Adds a new Fraction Group Summary Sequence (see FractionGroupSummarySequence) if it does not already exist.
default FractionGroupSummarySequence	getFractionGroupSummarySequence()
default FractionGroupSummarySequence	newFractionGroupSummarySequence(int initialCapacity)	Adds a new Fraction Group Summary Sequence.
default void	removeFractionGroupSummarySequence()	Removes the Fraction Group Summary Sequence (see FractionGroupSummarySequence
static FractionGroupSummarySequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Fraction Group Summary Sequence (see FractionGroupSummarySequence)

Returns:

a wrapper object implementing the FractionGroupSummarySequence.Holder interface.

builder

static FractionGroupSummarySequence.Holder.Builder builder()

Returns:

a FractionGroupSummarySequence.Holder.Builder to create Fraction Group Summary Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a FractionGroupSummarySequence.Holder.Builder to create Fraction Group Summary Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getFractionGroupSummarySequence

default FractionGroupSummarySequence getFractionGroupSummarySequence()

Returns:

the Fraction Group Summary Sequence (see FractionGroupSummarySequence)

newFractionGroupSummarySequence

default FractionGroupSummarySequence newFractionGroupSummarySequence(int initialCapacity)

Adds a new Fraction Group Summary Sequence. (see FractionGroupSummarySequence)

Parameters:

initialCapacity - the initial capacity for the new Fraction Group Summary Sequence

Returns:

the newly created FractionGroupSummarySequence.

ensureFractionGroupSummarySequence

default FractionGroupSummarySequence ensureFractionGroupSummarySequence(int initialCapacity)

Adds a new Fraction Group Summary Sequence (see FractionGroupSummarySequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Fraction Group Summary Sequence is created.

Returns:

either the already existing Fraction Group Summary Sequence (see FractionGroupSummarySequence) or a new one with capacity initialCapacity.

ensureFractionGroupSummarySequence

default FractionGroupSummarySequence ensureFractionGroupSummarySequence()

Adds a new Fraction Group Summary Sequence (see FractionGroupSummarySequence) with initial capacity 1 (see ensureFractionGroupSummarySequence(int)) if it does not already exist.

Returns:

either the already existing Fraction Group Summary Sequence (see FractionGroupSummarySequence) or a new one with capacity 1.

containsFractionGroupSummarySequence

default boolean containsFractionGroupSummarySequence()

Returns:

whether it contains the Fraction Group Summary Sequence (see FractionGroupSummarySequence)

removeFractionGroupSummarySequence

default void removeFractionGroupSummarySequence()

Removes the Fraction Group Summary Sequence (see FractionGroupSummarySequence