Package org.dcm4che.typeddicom.dataelements

Interface StructureSetROISequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

StructureSetModule

All Known Implementing Classes:

RTDoseIOD, RTStructureSetIOD, StructureSetModule.SimpleWrapper

Enclosing class:

StructureSetROISequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Structure Set ROI Sequence" (see StructureSetROISequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StructureSetROISequence.Holder.Builder	builder()
static StructureSetROISequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsStructureSetROISequence()
default StructureSetROISequence	ensureStructureSetROISequence()	Adds a new Structure Set ROI Sequence (see StructureSetROISequence) with initial capacity 1 (see ensureStructureSetROISequence(int)) if it does not already exist.
default StructureSetROISequence	ensureStructureSetROISequence(int initialCapacity)	Adds a new Structure Set ROI Sequence (see StructureSetROISequence) if it does not already exist.
default StructureSetROISequence	getStructureSetROISequence()
default StructureSetROISequence	newStructureSetROISequence(int initialCapacity)	Adds a new Structure Set ROI Sequence.
default void	removeStructureSetROISequence()	Removes the Structure Set ROI Sequence (see StructureSetROISequence
static StructureSetROISequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Structure Set ROI Sequence (see StructureSetROISequence)

Returns:

a wrapper object implementing the StructureSetROISequence.Holder interface.

builder

static StructureSetROISequence.Holder.Builder builder()

Returns:

a StructureSetROISequence.Holder.Builder to create Structure Set ROI Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getStructureSetROISequence

default StructureSetROISequence getStructureSetROISequence()

Returns:

the Structure Set ROI Sequence (see StructureSetROISequence)

newStructureSetROISequence

default StructureSetROISequence newStructureSetROISequence(int initialCapacity)

Adds a new Structure Set ROI Sequence. (see StructureSetROISequence)

Parameters:

initialCapacity - the initial capacity for the new Structure Set ROI Sequence

Returns:

the newly created StructureSetROISequence.

ensureStructureSetROISequence

default StructureSetROISequence ensureStructureSetROISequence(int initialCapacity)

Adds a new Structure Set ROI Sequence (see StructureSetROISequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Structure Set ROI Sequence (see StructureSetROISequence) or a new one with capacity initialCapacity.

ensureStructureSetROISequence

default StructureSetROISequence ensureStructureSetROISequence()

Adds a new Structure Set ROI Sequence (see StructureSetROISequence) with initial capacity 1 (see ensureStructureSetROISequence(int)) if it does not already exist.

Returns:

either the already existing Structure Set ROI Sequence (see StructureSetROISequence) or a new one with capacity 1.

containsStructureSetROISequence

default boolean containsStructureSetROISequence()

Returns:

whether it contains the Structure Set ROI Sequence (see StructureSetROISequence)

removeStructureSetROISequence

default void removeStructureSetROISequence()

Removes the Structure Set ROI Sequence (see StructureSetROISequence