Package org.dcm4che.typeddicom.dataelements

Interface ROIContourSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

ROIContourModule

All Known Implementing Classes:

ROIContourSequence.SimpleHolder, RTDoseIOD, RTStructureSetIOD

Enclosing class:

ROIContourSequence

public static interface ROIContourSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "ROI Contour Sequence" (see ROIContourSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ROIContourSequence.Holder.Builder	builder()
static ROIContourSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsROIContourSequence()
default ROIContourSequence	ensureROIContourSequence()	Adds a new ROI Contour Sequence (see ROIContourSequence) with initial capacity 1 (see ensureROIContourSequence(int)) if it does not already exist.
default ROIContourSequence	ensureROIContourSequence(int initialCapacity)	Adds a new ROI Contour Sequence (see ROIContourSequence) if it does not already exist.
default ROIContourSequence	getROIContourSequence()
default ROIContourSequence	newROIContourSequence(int initialCapacity)	Adds a new ROI Contour Sequence.
default void	removeROIContourSequence()	Removes the ROI Contour Sequence (see ROIContourSequence
static ROIContourSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the ROI Contour Sequence (see ROIContourSequence)

Returns:

A wrapper object implementing the ROIContourSequence.Holder interface.

builder

static ROIContourSequence.Holder.Builder builder()

Returns:

a ROIContourSequence.Holder.Builder to create ROI Contour Sequence Items with a fluent API.

builder

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

Parameters:

attributes - The Attributes to be wrapped by the ROIContourSequence.Holder.Builder.

Returns:

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

getROIContourSequence

default ROIContourSequence getROIContourSequence()

Returns:

the ROI Contour Sequence (see ROIContourSequence)

newROIContourSequence

default ROIContourSequence newROIContourSequence(int initialCapacity)

Adds a new ROI Contour Sequence. (see ROIContourSequence)

Parameters:

initialCapacity - the initial capacity for the new ROI Contour Sequence

ensureROIContourSequence

default ROIContourSequence ensureROIContourSequence(int initialCapacity)

Adds a new ROI Contour Sequence (see ROIContourSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new ROI Contour Sequence is created.

Returns:

Either the already existing ROI Contour Sequence (see ROIContourSequence) or a new one with capacity initialCapacity.

ensureROIContourSequence

default ROIContourSequence ensureROIContourSequence()

Adds a new ROI Contour Sequence (see ROIContourSequence) with initial capacity 1 (see ensureROIContourSequence(int)) if it does not already exist.

Returns:

Either the already existing ROI Contour Sequence (see ROIContourSequence) or a new one with capacity 1.

containsROIContourSequence

default boolean containsROIContourSequence()

Returns:

Whether it contains the ROI Contour Sequence (see ROIContourSequence)

removeROIContourSequence

default void removeROIContourSequence()

Removes the ROI Contour Sequence (see ROIContourSequence