Package org.dcm4che.typeddicom.dataelements

Interface PatientSupportDisplacementSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

PatientSupportDisplacementSequence.SimpleHolder, RTPatientPositionDisplacementSequence.Item

Enclosing class:

PatientSupportDisplacementSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Patient Support Displacement Sequence" (see PatientSupportDisplacementSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PatientSupportDisplacementSequence.Holder.Builder	builder()
static PatientSupportDisplacementSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPatientSupportDisplacementSequence()
default PatientSupportDisplacementSequence	ensurePatientSupportDisplacementSequence()	Adds a new Patient Support Displacement Sequence (see PatientSupportDisplacementSequence) with initial capacity 1 (see ensurePatientSupportDisplacementSequence(int)) if it does not already exist.
default PatientSupportDisplacementSequence	ensurePatientSupportDisplacementSequence(int initialCapacity)	Adds a new Patient Support Displacement Sequence (see PatientSupportDisplacementSequence) if it does not already exist.
default PatientSupportDisplacementSequence	getPatientSupportDisplacementSequence()
default PatientSupportDisplacementSequence	newPatientSupportDisplacementSequence(int initialCapacity)	Adds a new Patient Support Displacement Sequence.
default void	removePatientSupportDisplacementSequence()	Removes the Patient Support Displacement Sequence (see PatientSupportDisplacementSequence
static PatientSupportDisplacementSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Patient Support Displacement Sequence (see PatientSupportDisplacementSequence)

Returns:

a wrapper object implementing the PatientSupportDisplacementSequence.Holder interface.

builder

static PatientSupportDisplacementSequence.Holder.Builder builder()

Returns:

a PatientSupportDisplacementSequence.Holder.Builder to create Patient Support Displacement Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PatientSupportDisplacementSequence.Holder.Builder to create Patient Support Displacement Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPatientSupportDisplacementSequence

default PatientSupportDisplacementSequence getPatientSupportDisplacementSequence()

Returns:

the Patient Support Displacement Sequence (see PatientSupportDisplacementSequence)

newPatientSupportDisplacementSequence

default PatientSupportDisplacementSequence newPatientSupportDisplacementSequence(int initialCapacity)

Adds a new Patient Support Displacement Sequence. (see PatientSupportDisplacementSequence)

Parameters:

initialCapacity - the initial capacity for the new Patient Support Displacement Sequence

Returns:

the newly created PatientSupportDisplacementSequence.

ensurePatientSupportDisplacementSequence

default PatientSupportDisplacementSequence ensurePatientSupportDisplacementSequence(int initialCapacity)

Adds a new Patient Support Displacement Sequence (see PatientSupportDisplacementSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Patient Support Displacement Sequence (see PatientSupportDisplacementSequence) or a new one with capacity initialCapacity.

ensurePatientSupportDisplacementSequence

default PatientSupportDisplacementSequence ensurePatientSupportDisplacementSequence()

Adds a new Patient Support Displacement Sequence (see PatientSupportDisplacementSequence) with initial capacity 1 (see ensurePatientSupportDisplacementSequence(int)) if it does not already exist.

Returns:

either the already existing Patient Support Displacement Sequence (see PatientSupportDisplacementSequence) or a new one with capacity 1.

containsPatientSupportDisplacementSequence

default boolean containsPatientSupportDisplacementSequence()

Returns:

whether it contains the Patient Support Displacement Sequence (see PatientSupportDisplacementSequence)

removePatientSupportDisplacementSequence

default void removePatientSupportDisplacementSequence()

Removes the Patient Support Displacement Sequence (see PatientSupportDisplacementSequence