Package org.dcm4che.typeddicom.dataelements

Interface DVHReferencedROISequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

DVHReferencedROISequence.SimpleHolder, DVHSequence.Item

Enclosing class:

DVHReferencedROISequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "DVH Referenced ROI Sequence" (see DVHReferencedROISequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DVHReferencedROISequence.Holder.Builder	builder()
static DVHReferencedROISequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDVHReferencedROISequence()
default DVHReferencedROISequence	ensureDVHReferencedROISequence()	Adds a new DVH Referenced ROI Sequence (see DVHReferencedROISequence) with initial capacity 1 (see ensureDVHReferencedROISequence(int)) if it does not already exist.
default DVHReferencedROISequence	ensureDVHReferencedROISequence(int initialCapacity)	Adds a new DVH Referenced ROI Sequence (see DVHReferencedROISequence) if it does not already exist.
default DVHReferencedROISequence	getDVHReferencedROISequence()
default DVHReferencedROISequence	newDVHReferencedROISequence(int initialCapacity)	Adds a new DVH Referenced ROI Sequence.
default void	removeDVHReferencedROISequence()	Removes the DVH Referenced ROI Sequence (see DVHReferencedROISequence
static DVHReferencedROISequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the DVH Referenced ROI Sequence (see DVHReferencedROISequence)

Returns:

a wrapper object implementing the DVHReferencedROISequence.Holder interface.

builder

static DVHReferencedROISequence.Holder.Builder builder()

Returns:

a DVHReferencedROISequence.Holder.Builder to create DVH Referenced ROI Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDVHReferencedROISequence

default DVHReferencedROISequence getDVHReferencedROISequence()

Returns:

the DVH Referenced ROI Sequence (see DVHReferencedROISequence)

newDVHReferencedROISequence

default DVHReferencedROISequence newDVHReferencedROISequence(int initialCapacity)

Adds a new DVH Referenced ROI Sequence. (see DVHReferencedROISequence)

Parameters:

initialCapacity - the initial capacity for the new DVH Referenced ROI Sequence

Returns:

the newly created DVHReferencedROISequence.

ensureDVHReferencedROISequence

default DVHReferencedROISequence ensureDVHReferencedROISequence(int initialCapacity)

Adds a new DVH Referenced ROI Sequence (see DVHReferencedROISequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing DVH Referenced ROI Sequence (see DVHReferencedROISequence) or a new one with capacity initialCapacity.

ensureDVHReferencedROISequence

default DVHReferencedROISequence ensureDVHReferencedROISequence()

Adds a new DVH Referenced ROI Sequence (see DVHReferencedROISequence) with initial capacity 1 (see ensureDVHReferencedROISequence(int)) if it does not already exist.

Returns:

either the already existing DVH Referenced ROI Sequence (see DVHReferencedROISequence) or a new one with capacity 1.

containsDVHReferencedROISequence

default boolean containsDVHReferencedROISequence()

Returns:

whether it contains the DVH Referenced ROI Sequence (see DVHReferencedROISequence)

removeDVHReferencedROISequence

default void removeDVHReferencedROISequence()

Removes the DVH Referenced ROI Sequence (see DVHReferencedROISequence