Package org.dcm4che.typeddicom.dataelements

Interface RTROIIdentificationCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

RTROIIdentificationCodeSequence.SimpleHolder, RTROIObservationsSequence.Item

Enclosing class:

RTROIIdentificationCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTROIIdentificationCodeSequence.Holder.Builder	builder()
static RTROIIdentificationCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTROIIdentificationCodeSequence()
default RTROIIdentificationCodeSequence	ensureRTROIIdentificationCodeSequence()	Adds a new RT ROI Identification Code Sequence (see RTROIIdentificationCodeSequence) with initial capacity 1 (see ensureRTROIIdentificationCodeSequence(int)) if it does not already exist.
default RTROIIdentificationCodeSequence	ensureRTROIIdentificationCodeSequence(int initialCapacity)	Adds a new RT ROI Identification Code Sequence (see RTROIIdentificationCodeSequence) if it does not already exist.
default RTROIIdentificationCodeSequence	getRTROIIdentificationCodeSequence()
default RTROIIdentificationCodeSequence	newRTROIIdentificationCodeSequence(int initialCapacity)	Adds a new RT ROI Identification Code Sequence.
default void	removeRTROIIdentificationCodeSequence()	Removes the RT ROI Identification Code Sequence (see RTROIIdentificationCodeSequence
static RTROIIdentificationCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT ROI Identification Code Sequence (see RTROIIdentificationCodeSequence)

Returns:

a wrapper object implementing the RTROIIdentificationCodeSequence.Holder interface.

builder

static RTROIIdentificationCodeSequence.Holder.Builder builder()

Returns:

a RTROIIdentificationCodeSequence.Holder.Builder to create RT ROI Identification Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRTROIIdentificationCodeSequence

default RTROIIdentificationCodeSequence getRTROIIdentificationCodeSequence()

Returns:

the RT ROI Identification Code Sequence (see RTROIIdentificationCodeSequence)

newRTROIIdentificationCodeSequence

default RTROIIdentificationCodeSequence newRTROIIdentificationCodeSequence(int initialCapacity)

Adds a new RT ROI Identification Code Sequence. (see RTROIIdentificationCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new RT ROI Identification Code Sequence

Returns:

the newly created RTROIIdentificationCodeSequence.

ensureRTROIIdentificationCodeSequence

default RTROIIdentificationCodeSequence ensureRTROIIdentificationCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing RT ROI Identification Code Sequence (see RTROIIdentificationCodeSequence) or a new one with capacity initialCapacity.

ensureRTROIIdentificationCodeSequence

default RTROIIdentificationCodeSequence ensureRTROIIdentificationCodeSequence()

Adds a new RT ROI Identification Code Sequence (see RTROIIdentificationCodeSequence) with initial capacity 1 (see ensureRTROIIdentificationCodeSequence(int)) if it does not already exist.

Returns:

either the already existing RT ROI Identification Code Sequence (see RTROIIdentificationCodeSequence) or a new one with capacity 1.

containsRTROIIdentificationCodeSequence

default boolean containsRTROIIdentificationCodeSequence()

Returns:

whether it contains the RT ROI Identification Code Sequence (see RTROIIdentificationCodeSequence)

removeRTROIIdentificationCodeSequence

default void removeRTROIIdentificationCodeSequence()

Removes the RT ROI Identification Code Sequence (see RTROIIdentificationCodeSequence