Package org.dcm4che.typeddicom.dataelements

Interface PatientTreatmentPreparationProcedureSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTTreatmentPreparationModule

All Known Implementing Classes:

PatientTreatmentPreparationProcedureSequence.SimpleHolder, RTTreatmentPreparationIOD

Enclosing class:

PatientTreatmentPreparationProcedureSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PatientTreatmentPreparationProcedureSequence.Holder.Builder	builder()
static PatientTreatmentPreparationProcedureSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPatientTreatmentPreparationProcedureSequence()
default PatientTreatmentPreparationProcedureSequence	ensurePatientTreatmentPreparationProcedureSequence()	Adds a new Patient Treatment Preparation Procedure Sequence (see PatientTreatmentPreparationProcedureSequence) with initial capacity 1 (see ensurePatientTreatmentPreparationProcedureSequence(int)) if it does not already exist.
default PatientTreatmentPreparationProcedureSequence	ensurePatientTreatmentPreparationProcedureSequence(int initialCapacity)	Adds a new Patient Treatment Preparation Procedure Sequence (see PatientTreatmentPreparationProcedureSequence) if it does not already exist.
default PatientTreatmentPreparationProcedureSequence	getPatientTreatmentPreparationProcedureSequence()
default PatientTreatmentPreparationProcedureSequence	newPatientTreatmentPreparationProcedureSequence(int initialCapacity)	Adds a new Patient Treatment Preparation Procedure Sequence.
default void	removePatientTreatmentPreparationProcedureSequence()	Removes the Patient Treatment Preparation Procedure Sequence (see PatientTreatmentPreparationProcedureSequence
static PatientTreatmentPreparationProcedureSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Patient Treatment Preparation Procedure Sequence (see PatientTreatmentPreparationProcedureSequence)

Returns:

a wrapper object implementing the PatientTreatmentPreparationProcedureSequence.Holder interface.

builder

static PatientTreatmentPreparationProcedureSequence.Holder.Builder builder()

Returns:

a PatientTreatmentPreparationProcedureSequence.Holder.Builder to create Patient Treatment Preparation Procedure Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPatientTreatmentPreparationProcedureSequence

default PatientTreatmentPreparationProcedureSequence getPatientTreatmentPreparationProcedureSequence()

Returns:

the Patient Treatment Preparation Procedure Sequence (see PatientTreatmentPreparationProcedureSequence)

newPatientTreatmentPreparationProcedureSequence

default PatientTreatmentPreparationProcedureSequence newPatientTreatmentPreparationProcedureSequence(int initialCapacity)

Adds a new Patient Treatment Preparation Procedure Sequence. (see PatientTreatmentPreparationProcedureSequence)

Parameters:

initialCapacity - the initial capacity for the new Patient Treatment Preparation Procedure Sequence

Returns:

the newly created PatientTreatmentPreparationProcedureSequence.

ensurePatientTreatmentPreparationProcedureSequence

default PatientTreatmentPreparationProcedureSequence ensurePatientTreatmentPreparationProcedureSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing Patient Treatment Preparation Procedure Sequence (see PatientTreatmentPreparationProcedureSequence) or a new one with capacity initialCapacity.

ensurePatientTreatmentPreparationProcedureSequence

default PatientTreatmentPreparationProcedureSequence ensurePatientTreatmentPreparationProcedureSequence()

Adds a new Patient Treatment Preparation Procedure Sequence (see PatientTreatmentPreparationProcedureSequence) with initial capacity 1 (see ensurePatientTreatmentPreparationProcedureSequence(int)) if it does not already exist.

Returns:

either the already existing Patient Treatment Preparation Procedure Sequence (see PatientTreatmentPreparationProcedureSequence) or a new one with capacity 1.

containsPatientTreatmentPreparationProcedureSequence

default boolean containsPatientTreatmentPreparationProcedureSequence()

Returns:

whether it contains the Patient Treatment Preparation Procedure Sequence (see PatientTreatmentPreparationProcedureSequence)

removePatientTreatmentPreparationProcedureSequence

default void removePatientTreatmentPreparationProcedureSequence()

Removes the Patient Treatment Preparation Procedure Sequence (see PatientTreatmentPreparationProcedureSequence