Package org.dcm4che.typeddicom.dataelements

Interface RTRelatedROISequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

RTRelatedROISequence.SimpleHolder, RTROIObservationsSequence.Item

Enclosing class:

RTRelatedROISequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTRelatedROISequence.Holder.Builder	builder()
static RTRelatedROISequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTRelatedROISequence()
default RTRelatedROISequence	ensureRTRelatedROISequence()	Adds a new RT Related ROI Sequence (see RTRelatedROISequence) with initial capacity 1 (see ensureRTRelatedROISequence(int)) if it does not already exist.
default RTRelatedROISequence	ensureRTRelatedROISequence(int initialCapacity)	Adds a new RT Related ROI Sequence (see RTRelatedROISequence) if it does not already exist.
default RTRelatedROISequence	getRTRelatedROISequence()
default RTRelatedROISequence	newRTRelatedROISequence(int initialCapacity)	Adds a new RT Related ROI Sequence.
default void	removeRTRelatedROISequence()	Removes the RT Related ROI Sequence (see RTRelatedROISequence
static RTRelatedROISequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the RTRelatedROISequence.Holder interface.

builder

static RTRelatedROISequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getRTRelatedROISequence

default RTRelatedROISequence getRTRelatedROISequence()

Returns:

the RT Related ROI Sequence (see RTRelatedROISequence)

newRTRelatedROISequence

default RTRelatedROISequence newRTRelatedROISequence(int initialCapacity)

Adds a new RT Related ROI Sequence. (see RTRelatedROISequence)

Parameters:

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

Returns:

the newly created RTRelatedROISequence.

ensureRTRelatedROISequence

default RTRelatedROISequence ensureRTRelatedROISequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureRTRelatedROISequence

default RTRelatedROISequence ensureRTRelatedROISequence()

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

Returns:

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

containsRTRelatedROISequence

default boolean containsRTRelatedROISequence()

Returns:

whether it contains the RT Related ROI Sequence (see RTRelatedROISequence)

removeRTRelatedROISequence

default void removeRTRelatedROISequence()

Removes the RT Related ROI Sequence (see RTRelatedROISequence