Package org.dcm4che.typeddicom.dataelements

Interface PlanningLandmarkPointSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

GenericImplantTemplatePlanningLandmarksModule

All Known Implementing Classes:

GenericImplantTemplateIOD, GenericImplantTemplatePlanningLandmarksModule.SimpleWrapper

Enclosing class:

PlanningLandmarkPointSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Planning Landmark Point Sequence" (see PlanningLandmarkPointSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PlanningLandmarkPointSequence.Holder.Builder	builder()
static PlanningLandmarkPointSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPlanningLandmarkPointSequence()
default PlanningLandmarkPointSequence	ensurePlanningLandmarkPointSequence()	Adds a new Planning Landmark Point Sequence (see PlanningLandmarkPointSequence) with initial capacity 1 (see ensurePlanningLandmarkPointSequence(int)) if it does not already exist.
default PlanningLandmarkPointSequence	ensurePlanningLandmarkPointSequence(int initialCapacity)	Adds a new Planning Landmark Point Sequence (see PlanningLandmarkPointSequence) if it does not already exist.
default PlanningLandmarkPointSequence	getPlanningLandmarkPointSequence()
default PlanningLandmarkPointSequence	newPlanningLandmarkPointSequence(int initialCapacity)	Adds a new Planning Landmark Point Sequence.
default void	removePlanningLandmarkPointSequence()	Removes the Planning Landmark Point Sequence (see PlanningLandmarkPointSequence
static PlanningLandmarkPointSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Planning Landmark Point Sequence (see PlanningLandmarkPointSequence)

Returns:

a wrapper object implementing the PlanningLandmarkPointSequence.Holder interface.

builder

static PlanningLandmarkPointSequence.Holder.Builder builder()

Returns:

a PlanningLandmarkPointSequence.Holder.Builder to create Planning Landmark Point Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PlanningLandmarkPointSequence.Holder.Builder to create Planning Landmark Point Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPlanningLandmarkPointSequence

default PlanningLandmarkPointSequence getPlanningLandmarkPointSequence()

Returns:

the Planning Landmark Point Sequence (see PlanningLandmarkPointSequence)

newPlanningLandmarkPointSequence

default PlanningLandmarkPointSequence newPlanningLandmarkPointSequence(int initialCapacity)

Adds a new Planning Landmark Point Sequence. (see PlanningLandmarkPointSequence)

Parameters:

initialCapacity - the initial capacity for the new Planning Landmark Point Sequence

Returns:

the newly created PlanningLandmarkPointSequence.

ensurePlanningLandmarkPointSequence

default PlanningLandmarkPointSequence ensurePlanningLandmarkPointSequence(int initialCapacity)

Adds a new Planning Landmark Point Sequence (see PlanningLandmarkPointSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Planning Landmark Point Sequence is created.

Returns:

either the already existing Planning Landmark Point Sequence (see PlanningLandmarkPointSequence) or a new one with capacity initialCapacity.

ensurePlanningLandmarkPointSequence

default PlanningLandmarkPointSequence ensurePlanningLandmarkPointSequence()

Adds a new Planning Landmark Point Sequence (see PlanningLandmarkPointSequence) with initial capacity 1 (see ensurePlanningLandmarkPointSequence(int)) if it does not already exist.

Returns:

either the already existing Planning Landmark Point Sequence (see PlanningLandmarkPointSequence) or a new one with capacity 1.

containsPlanningLandmarkPointSequence

default boolean containsPlanningLandmarkPointSequence()

Returns:

whether it contains the Planning Landmark Point Sequence (see PlanningLandmarkPointSequence)

removePlanningLandmarkPointSequence

default void removePlanningLandmarkPointSequence()

Removes the Planning Landmark Point Sequence (see PlanningLandmarkPointSequence