Package org.dcm4che.typeddicom.dataelements

Interface TreatmentSiteCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTGeneralPlanModule

All Known Implementing Classes:

PlanOverviewSequence.Item, RTIonPlanIOD, RTPhysicianIntentSequence.Item, RTPlanIOD, TreatmentSiteCodeSequence.SimpleHolder

Enclosing class:

TreatmentSiteCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Treatment Site Code Sequence" (see TreatmentSiteCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TreatmentSiteCodeSequence.Holder.Builder	builder()
static TreatmentSiteCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTreatmentSiteCodeSequence()
default TreatmentSiteCodeSequence	ensureTreatmentSiteCodeSequence()	Adds a new Treatment Site Code Sequence (see TreatmentSiteCodeSequence) with initial capacity 1 (see ensureTreatmentSiteCodeSequence(int)) if it does not already exist.
default TreatmentSiteCodeSequence	ensureTreatmentSiteCodeSequence(int initialCapacity)	Adds a new Treatment Site Code Sequence (see TreatmentSiteCodeSequence) if it does not already exist.
default TreatmentSiteCodeSequence	getTreatmentSiteCodeSequence()
default TreatmentSiteCodeSequence	newTreatmentSiteCodeSequence(int initialCapacity)	Adds a new Treatment Site Code Sequence.
default void	removeTreatmentSiteCodeSequence()	Removes the Treatment Site Code Sequence (see TreatmentSiteCodeSequence
static TreatmentSiteCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Treatment Site Code Sequence (see TreatmentSiteCodeSequence)

Returns:

a wrapper object implementing the TreatmentSiteCodeSequence.Holder interface.

builder

static TreatmentSiteCodeSequence.Holder.Builder builder()

Returns:

a TreatmentSiteCodeSequence.Holder.Builder to create Treatment Site Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a TreatmentSiteCodeSequence.Holder.Builder to create Treatment Site Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getTreatmentSiteCodeSequence

default TreatmentSiteCodeSequence getTreatmentSiteCodeSequence()

Returns:

the Treatment Site Code Sequence (see TreatmentSiteCodeSequence)

newTreatmentSiteCodeSequence

default TreatmentSiteCodeSequence newTreatmentSiteCodeSequence(int initialCapacity)

Adds a new Treatment Site Code Sequence. (see TreatmentSiteCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Treatment Site Code Sequence

Returns:

the newly created TreatmentSiteCodeSequence.

ensureTreatmentSiteCodeSequence

default TreatmentSiteCodeSequence ensureTreatmentSiteCodeSequence(int initialCapacity)

Adds a new Treatment Site Code Sequence (see TreatmentSiteCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Treatment Site Code Sequence (see TreatmentSiteCodeSequence) or a new one with capacity initialCapacity.

ensureTreatmentSiteCodeSequence

default TreatmentSiteCodeSequence ensureTreatmentSiteCodeSequence()

Adds a new Treatment Site Code Sequence (see TreatmentSiteCodeSequence) with initial capacity 1 (see ensureTreatmentSiteCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Treatment Site Code Sequence (see TreatmentSiteCodeSequence) or a new one with capacity 1.

containsTreatmentSiteCodeSequence

default boolean containsTreatmentSiteCodeSequence()

Returns:

whether it contains the Treatment Site Code Sequence (see TreatmentSiteCodeSequence)

removeTreatmentSiteCodeSequence

default void removeTreatmentSiteCodeSequence()

Removes the Treatment Site Code Sequence (see TreatmentSiteCodeSequence