Package org.dcm4che.typeddicom.dataelements

Interface PositioningLandmarkSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

PatientPositioningModule

All Known Implementing Classes:

CTDefinedProcedureProtocolIOD, CTPerformedProcedureProtocolIOD, PositioningLandmarkSequence.SimpleHolder, XADefinedProcedureProtocolIOD, XAPerformedProcedureProtocolIOD

Enclosing class:

PositioningLandmarkSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Positioning Landmark Sequence" (see PositioningLandmarkSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PositioningLandmarkSequence.Holder.Builder	builder()
static PositioningLandmarkSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPositioningLandmarkSequence()
default PositioningLandmarkSequence	ensurePositioningLandmarkSequence()	Adds a new Positioning Landmark Sequence (see PositioningLandmarkSequence) with initial capacity 1 (see ensurePositioningLandmarkSequence(int)) if it does not already exist.
default PositioningLandmarkSequence	ensurePositioningLandmarkSequence(int initialCapacity)	Adds a new Positioning Landmark Sequence (see PositioningLandmarkSequence) if it does not already exist.
default PositioningLandmarkSequence	getPositioningLandmarkSequence()
default PositioningLandmarkSequence	newPositioningLandmarkSequence(int initialCapacity)	Adds a new Positioning Landmark Sequence.
default void	removePositioningLandmarkSequence()	Removes the Positioning Landmark Sequence (see PositioningLandmarkSequence
static PositioningLandmarkSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Positioning Landmark Sequence (see PositioningLandmarkSequence)

Returns:

a wrapper object implementing the PositioningLandmarkSequence.Holder interface.

builder

static PositioningLandmarkSequence.Holder.Builder builder()

Returns:

a PositioningLandmarkSequence.Holder.Builder to create Positioning Landmark Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPositioningLandmarkSequence

default PositioningLandmarkSequence getPositioningLandmarkSequence()

Returns:

the Positioning Landmark Sequence (see PositioningLandmarkSequence)

newPositioningLandmarkSequence

default PositioningLandmarkSequence newPositioningLandmarkSequence(int initialCapacity)

Adds a new Positioning Landmark Sequence. (see PositioningLandmarkSequence)

Parameters:

initialCapacity - the initial capacity for the new Positioning Landmark Sequence

Returns:

the newly created PositioningLandmarkSequence.

ensurePositioningLandmarkSequence

default PositioningLandmarkSequence ensurePositioningLandmarkSequence(int initialCapacity)

Adds a new Positioning Landmark Sequence (see PositioningLandmarkSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Positioning Landmark Sequence (see PositioningLandmarkSequence) or a new one with capacity initialCapacity.

ensurePositioningLandmarkSequence

default PositioningLandmarkSequence ensurePositioningLandmarkSequence()

Adds a new Positioning Landmark Sequence (see PositioningLandmarkSequence) with initial capacity 1 (see ensurePositioningLandmarkSequence(int)) if it does not already exist.

Returns:

either the already existing Positioning Landmark Sequence (see PositioningLandmarkSequence) or a new one with capacity 1.

containsPositioningLandmarkSequence

default boolean containsPositioningLandmarkSequence()

Returns:

whether it contains the Positioning Landmark Sequence (see PositioningLandmarkSequence)

removePositioningLandmarkSequence

default void removePositioningLandmarkSequence()

Removes the Positioning Landmark Sequence (see PositioningLandmarkSequence