Package org.dcm4che.typeddicom.dataelements

Interface FractionGroupSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTFractionSchemeModule

All Known Implementing Classes:

RTFractionSchemeModule.SimpleWrapper, RTIonPlanIOD, RTPlanIOD

Enclosing class:

FractionGroupSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FractionGroupSequence.Holder.Builder	builder()
static FractionGroupSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFractionGroupSequence()
default FractionGroupSequence	ensureFractionGroupSequence()	Adds a new Fraction Group Sequence (see FractionGroupSequence) with initial capacity 1 (see ensureFractionGroupSequence(int)) if it does not already exist.
default FractionGroupSequence	ensureFractionGroupSequence(int initialCapacity)	Adds a new Fraction Group Sequence (see FractionGroupSequence) if it does not already exist.
default FractionGroupSequence	getFractionGroupSequence()
default FractionGroupSequence	newFractionGroupSequence(int initialCapacity)	Adds a new Fraction Group Sequence.
default void	removeFractionGroupSequence()	Removes the Fraction Group Sequence (see FractionGroupSequence
static FractionGroupSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the FractionGroupSequence.Holder interface.

builder

static FractionGroupSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getFractionGroupSequence

default FractionGroupSequence getFractionGroupSequence()

Returns:

the Fraction Group Sequence (see FractionGroupSequence)

newFractionGroupSequence

default FractionGroupSequence newFractionGroupSequence(int initialCapacity)

Adds a new Fraction Group Sequence. (see FractionGroupSequence)

Parameters:

initialCapacity - the initial capacity for the new Fraction Group Sequence

Returns:

the newly created FractionGroupSequence.

ensureFractionGroupSequence

default FractionGroupSequence ensureFractionGroupSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureFractionGroupSequence

default FractionGroupSequence ensureFractionGroupSequence()

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

Returns:

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

containsFractionGroupSequence

default boolean containsFractionGroupSequence()

Returns:

whether it contains the Fraction Group Sequence (see FractionGroupSequence)

removeFractionGroupSequence

default void removeFractionGroupSequence()

Removes the Fraction Group Sequence (see FractionGroupSequence