Package org.dcm4che.typeddicom.dataelements

Interface PatientTreatmentOrientationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

PatientTreatmentOrientationSequence.SimpleHolder, RTPrescriptionSequence.Item

Enclosing class:

PatientTreatmentOrientationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Patient Treatment Orientation Sequence" (see PatientTreatmentOrientationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PatientTreatmentOrientationSequence.Holder.Builder	builder()
static PatientTreatmentOrientationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPatientTreatmentOrientationSequence()
default PatientTreatmentOrientationSequence	ensurePatientTreatmentOrientationSequence()	Adds a new Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence) with initial capacity 1 (see ensurePatientTreatmentOrientationSequence(int)) if it does not already exist.
default PatientTreatmentOrientationSequence	ensurePatientTreatmentOrientationSequence(int initialCapacity)	Adds a new Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence) if it does not already exist.
default PatientTreatmentOrientationSequence	getPatientTreatmentOrientationSequence()
default PatientTreatmentOrientationSequence	newPatientTreatmentOrientationSequence(int initialCapacity)	Adds a new Patient Treatment Orientation Sequence.
default void	removePatientTreatmentOrientationSequence()	Removes the Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence
static PatientTreatmentOrientationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence)

Returns:

a wrapper object implementing the PatientTreatmentOrientationSequence.Holder interface.

builder

static PatientTreatmentOrientationSequence.Holder.Builder builder()

Returns:

a PatientTreatmentOrientationSequence.Holder.Builder to create Patient Treatment Orientation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PatientTreatmentOrientationSequence.Holder.Builder to create Patient Treatment Orientation Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPatientTreatmentOrientationSequence

default PatientTreatmentOrientationSequence getPatientTreatmentOrientationSequence()

Returns:

the Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence)

newPatientTreatmentOrientationSequence

default PatientTreatmentOrientationSequence newPatientTreatmentOrientationSequence(int initialCapacity)

Adds a new Patient Treatment Orientation Sequence. (see PatientTreatmentOrientationSequence)

Parameters:

initialCapacity - the initial capacity for the new Patient Treatment Orientation Sequence

Returns:

the newly created PatientTreatmentOrientationSequence.

ensurePatientTreatmentOrientationSequence

default PatientTreatmentOrientationSequence ensurePatientTreatmentOrientationSequence(int initialCapacity)

Adds a new Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence) or a new one with capacity initialCapacity.

ensurePatientTreatmentOrientationSequence

default PatientTreatmentOrientationSequence ensurePatientTreatmentOrientationSequence()

Adds a new Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence) with initial capacity 1 (see ensurePatientTreatmentOrientationSequence(int)) if it does not already exist.

Returns:

either the already existing Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence) or a new one with capacity 1.

containsPatientTreatmentOrientationSequence

default boolean containsPatientTreatmentOrientationSequence()

Returns:

whether it contains the Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence)

removePatientTreatmentOrientationSequence

default void removePatientTreatmentOrientationSequence()

Removes the Patient Treatment Orientation Sequence (see PatientTreatmentOrientationSequence