Package org.dcm4che.typeddicom.dataelements

Interface PlanOverviewSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTDoseModule

All Known Implementing Classes:

PlanOverviewSequence.SimpleHolder, RTDoseIOD

Enclosing class:

PlanOverviewSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Plan Overview Sequence" (see PlanOverviewSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PlanOverviewSequence.Holder.Builder	builder()
static PlanOverviewSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPlanOverviewSequence()
default PlanOverviewSequence	ensurePlanOverviewSequence()	Adds a new Plan Overview Sequence (see PlanOverviewSequence) with initial capacity 1 (see ensurePlanOverviewSequence(int)) if it does not already exist.
default PlanOverviewSequence	ensurePlanOverviewSequence(int initialCapacity)	Adds a new Plan Overview Sequence (see PlanOverviewSequence) if it does not already exist.
default PlanOverviewSequence	getPlanOverviewSequence()
default PlanOverviewSequence	newPlanOverviewSequence(int initialCapacity)	Adds a new Plan Overview Sequence.
default void	removePlanOverviewSequence()	Removes the Plan Overview Sequence (see PlanOverviewSequence
static PlanOverviewSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Plan Overview Sequence (see PlanOverviewSequence)

Returns:

a wrapper object implementing the PlanOverviewSequence.Holder interface.

builder

static PlanOverviewSequence.Holder.Builder builder()

Returns:

a PlanOverviewSequence.Holder.Builder to create Plan Overview Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PlanOverviewSequence.Holder.Builder to create Plan Overview Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPlanOverviewSequence

default PlanOverviewSequence getPlanOverviewSequence()

Returns:

the Plan Overview Sequence (see PlanOverviewSequence)

newPlanOverviewSequence

default PlanOverviewSequence newPlanOverviewSequence(int initialCapacity)

Adds a new Plan Overview Sequence. (see PlanOverviewSequence)

Parameters:

initialCapacity - the initial capacity for the new Plan Overview Sequence

Returns:

the newly created PlanOverviewSequence.

ensurePlanOverviewSequence

default PlanOverviewSequence ensurePlanOverviewSequence(int initialCapacity)

Adds a new Plan Overview Sequence (see PlanOverviewSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Plan Overview Sequence (see PlanOverviewSequence) or a new one with capacity initialCapacity.

ensurePlanOverviewSequence

default PlanOverviewSequence ensurePlanOverviewSequence()

Adds a new Plan Overview Sequence (see PlanOverviewSequence) with initial capacity 1 (see ensurePlanOverviewSequence(int)) if it does not already exist.

Returns:

either the already existing Plan Overview Sequence (see PlanOverviewSequence) or a new one with capacity 1.

containsPlanOverviewSequence

default boolean containsPlanOverviewSequence()

Returns:

whether it contains the Plan Overview Sequence (see PlanOverviewSequence)

removePlanOverviewSequence

default void removePlanOverviewSequence()

Removes the Plan Overview Sequence (see PlanOverviewSequence