Package org.dcm4che.typeddicom.dataelements

Interface PatientOrientationInFrameSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

CurrentFrameFunctionalGroupsSequence.Item, PerFrameFunctionalGroupsSequence.Item, SelectedFrameFunctionalGroupsSequence.Item, SharedFunctionalGroupsSequence.Item

Enclosing class:

PatientOrientationInFrameSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PatientOrientationInFrameSequence.Holder.Builder	builder()
static PatientOrientationInFrameSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPatientOrientationInFrameSequence()
default PatientOrientationInFrameSequence	ensurePatientOrientationInFrameSequence()	Adds a new Patient Orientation in Frame Sequence (see PatientOrientationInFrameSequence) with initial capacity 1 (see ensurePatientOrientationInFrameSequence(int)) if it does not already exist.
default PatientOrientationInFrameSequence	ensurePatientOrientationInFrameSequence(int initialCapacity)	Adds a new Patient Orientation in Frame Sequence (see PatientOrientationInFrameSequence) if it does not already exist.
default PatientOrientationInFrameSequence	getPatientOrientationInFrameSequence()
default PatientOrientationInFrameSequence	newPatientOrientationInFrameSequence(int initialCapacity)	Adds a new Patient Orientation in Frame Sequence.
default void	removePatientOrientationInFrameSequence()	Removes the Patient Orientation in Frame Sequence (see PatientOrientationInFrameSequence
static PatientOrientationInFrameSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Patient Orientation in Frame Sequence (see PatientOrientationInFrameSequence)

Returns:

a wrapper object implementing the PatientOrientationInFrameSequence.Holder interface.

builder

static PatientOrientationInFrameSequence.Holder.Builder builder()

Returns:

a PatientOrientationInFrameSequence.Holder.Builder to create Patient Orientation in Frame Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPatientOrientationInFrameSequence

default PatientOrientationInFrameSequence getPatientOrientationInFrameSequence()

Returns:

the Patient Orientation in Frame Sequence (see PatientOrientationInFrameSequence)

newPatientOrientationInFrameSequence

default PatientOrientationInFrameSequence newPatientOrientationInFrameSequence(int initialCapacity)

Adds a new Patient Orientation in Frame Sequence. (see PatientOrientationInFrameSequence)

Parameters:

initialCapacity - the initial capacity for the new Patient Orientation in Frame Sequence

Returns:

the newly created PatientOrientationInFrameSequence.

ensurePatientOrientationInFrameSequence

default PatientOrientationInFrameSequence ensurePatientOrientationInFrameSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing Patient Orientation in Frame Sequence (see PatientOrientationInFrameSequence) or a new one with capacity initialCapacity.

ensurePatientOrientationInFrameSequence

default PatientOrientationInFrameSequence ensurePatientOrientationInFrameSequence()

Adds a new Patient Orientation in Frame Sequence (see PatientOrientationInFrameSequence) with initial capacity 1 (see ensurePatientOrientationInFrameSequence(int)) if it does not already exist.

Returns:

either the already existing Patient Orientation in Frame Sequence (see PatientOrientationInFrameSequence) or a new one with capacity 1.

containsPatientOrientationInFrameSequence

default boolean containsPatientOrientationInFrameSequence()

Returns:

whether it contains the Patient Orientation in Frame Sequence (see PatientOrientationInFrameSequence)

removePatientOrientationInFrameSequence

default void removePatientOrientationInFrameSequence()

Removes the Patient Orientation in Frame Sequence (see PatientOrientationInFrameSequence