Package org.dcm4che.typeddicom.dataelements

Interface RelatedRTROIObservationsSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

RTROIObservationsSequence.Item

Enclosing class:

RelatedRTROIObservationsSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Related RT ROI Observations Sequence" (see RelatedRTROIObservationsSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RelatedRTROIObservationsSequence.Holder.Builder	builder()
static RelatedRTROIObservationsSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRelatedRTROIObservationsSequence()
default RelatedRTROIObservationsSequence	ensureRelatedRTROIObservationsSequence()	Adds a new Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence) with initial capacity 1 (see ensureRelatedRTROIObservationsSequence(int)) if it does not already exist.
default RelatedRTROIObservationsSequence	ensureRelatedRTROIObservationsSequence(int initialCapacity)	Adds a new Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence) if it does not already exist.
default RelatedRTROIObservationsSequence	getRelatedRTROIObservationsSequence()
default RelatedRTROIObservationsSequence	newRelatedRTROIObservationsSequence(int initialCapacity)	Adds a new Related RT ROI Observations Sequence.
default void	removeRelatedRTROIObservationsSequence()	Removes the Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence
static RelatedRTROIObservationsSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence)

Returns:

a wrapper object implementing the RelatedRTROIObservationsSequence.Holder interface.

builder

static RelatedRTROIObservationsSequence.Holder.Builder builder()

Returns:

a RelatedRTROIObservationsSequence.Holder.Builder to create Related RT ROI Observations Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a RelatedRTROIObservationsSequence.Holder.Builder to create Related RT ROI Observations Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRelatedRTROIObservationsSequence

default RelatedRTROIObservationsSequence getRelatedRTROIObservationsSequence()

Returns:

the Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence)

newRelatedRTROIObservationsSequence

default RelatedRTROIObservationsSequence newRelatedRTROIObservationsSequence(int initialCapacity)

Adds a new Related RT ROI Observations Sequence. (see RelatedRTROIObservationsSequence)

Parameters:

initialCapacity - the initial capacity for the new Related RT ROI Observations Sequence

Returns:

the newly created RelatedRTROIObservationsSequence.

ensureRelatedRTROIObservationsSequence

default RelatedRTROIObservationsSequence ensureRelatedRTROIObservationsSequence(int initialCapacity)

Adds a new Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Related RT ROI Observations Sequence is created.

Returns:

either the already existing Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence) or a new one with capacity initialCapacity.

ensureRelatedRTROIObservationsSequence

default RelatedRTROIObservationsSequence ensureRelatedRTROIObservationsSequence()

Adds a new Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence) with initial capacity 1 (see ensureRelatedRTROIObservationsSequence(int)) if it does not already exist.

Returns:

either the already existing Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence) or a new one with capacity 1.

containsRelatedRTROIObservationsSequence

default boolean containsRelatedRTROIObservationsSequence()

Returns:

whether it contains the Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence)

removeRelatedRTROIObservationsSequence

default void removeRelatedRTROIObservationsSequence()

Removes the Related RT ROI Observations Sequence (see RelatedRTROIObservationsSequence