Package org.dcm4che.typeddicom.dataelements

Interface PatientOrientationCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

DXPositioningModule, EnhancedXAXRFImageModuleTable, NMPETPatientOrientationModule, PatientOrientationModule, RTRadiationCommonModule, RTRadiationRecordCommonModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, NMImageIOD, PatientOrientationCodeSequence.SimpleHolder, PatientTreatmentOrientationSequence.Item, PETImageIOD, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RTDeliveryStartPatientPositionSequence.Item, RTRadiationSalvageRecordIOD, RTTreatmentPreparationPatientPositionSequence.Item, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD

Enclosing class:

PatientOrientationCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PatientOrientationCodeSequence.Holder.Builder	builder()
static PatientOrientationCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPatientOrientationCodeSequence()
default PatientOrientationCodeSequence	ensurePatientOrientationCodeSequence()	Adds a new Patient Orientation Code Sequence (see PatientOrientationCodeSequence) with initial capacity 1 (see ensurePatientOrientationCodeSequence(int)) if it does not already exist.
default PatientOrientationCodeSequence	ensurePatientOrientationCodeSequence(int initialCapacity)	Adds a new Patient Orientation Code Sequence (see PatientOrientationCodeSequence) if it does not already exist.
default PatientOrientationCodeSequence	getPatientOrientationCodeSequence()
default PatientOrientationCodeSequence	newPatientOrientationCodeSequence(int initialCapacity)	Adds a new Patient Orientation Code Sequence.
default void	removePatientOrientationCodeSequence()	Removes the Patient Orientation Code Sequence (see PatientOrientationCodeSequence
static PatientOrientationCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Patient Orientation Code Sequence (see PatientOrientationCodeSequence)

Returns:

a wrapper object implementing the PatientOrientationCodeSequence.Holder interface.

builder

static PatientOrientationCodeSequence.Holder.Builder builder()

Returns:

a PatientOrientationCodeSequence.Holder.Builder to create Patient Orientation Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPatientOrientationCodeSequence

default PatientOrientationCodeSequence getPatientOrientationCodeSequence()

Returns:

the Patient Orientation Code Sequence (see PatientOrientationCodeSequence)

newPatientOrientationCodeSequence

default PatientOrientationCodeSequence newPatientOrientationCodeSequence(int initialCapacity)

Adds a new Patient Orientation Code Sequence. (see PatientOrientationCodeSequence)

Parameters:

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

Returns:

the newly created PatientOrientationCodeSequence.

ensurePatientOrientationCodeSequence

default PatientOrientationCodeSequence ensurePatientOrientationCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensurePatientOrientationCodeSequence

default PatientOrientationCodeSequence ensurePatientOrientationCodeSequence()

Adds a new Patient Orientation Code Sequence (see PatientOrientationCodeSequence) with initial capacity 1 (see ensurePatientOrientationCodeSequence(int)) if it does not already exist.

Returns:

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

containsPatientOrientationCodeSequence

default boolean containsPatientOrientationCodeSequence()

Returns:

whether it contains the Patient Orientation Code Sequence (see PatientOrientationCodeSequence)

removePatientOrientationCodeSequence

default void removePatientOrientationCodeSequence()

Removes the Patient Orientation Code Sequence (see PatientOrientationCodeSequence