Package org.dcm4che.typeddicom.dataelements

Interface DVHSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTDVHModule

All Known Implementing Classes:

DVHSequence.SimpleHolder, RTDoseIOD

Enclosing class:

DVHSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DVHSequence.Holder.Builder	builder()
static DVHSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDVHSequence()
default DVHSequence	ensureDVHSequence()	Adds a new DVH Sequence (see DVHSequence) with initial capacity 1 (see ensureDVHSequence(int)) if it does not already exist.
default DVHSequence	ensureDVHSequence(int initialCapacity)	Adds a new DVH Sequence (see DVHSequence) if it does not already exist.
default DVHSequence	getDVHSequence()
default DVHSequence	newDVHSequence(int initialCapacity)	Adds a new DVH Sequence.
default void	removeDVHSequence()	Removes the DVH Sequence (see DVHSequence
static DVHSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the DVH Sequence (see DVHSequence)

Returns:

a wrapper object implementing the DVHSequence.Holder interface.

builder

static DVHSequence.Holder.Builder builder()

Returns:

a DVHSequence.Holder.Builder to create DVH Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDVHSequence

default DVHSequence getDVHSequence()

Returns:

the DVH Sequence (see DVHSequence)

newDVHSequence

default DVHSequence newDVHSequence(int initialCapacity)

Adds a new DVH Sequence. (see DVHSequence)

Parameters:

initialCapacity - the initial capacity for the new DVH Sequence

Returns:

the newly created DVHSequence.

ensureDVHSequence

default DVHSequence ensureDVHSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureDVHSequence

default DVHSequence ensureDVHSequence()

Adds a new DVH Sequence (see DVHSequence) with initial capacity 1 (see ensureDVHSequence(int)) if it does not already exist.

Returns:

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

containsDVHSequence

default boolean containsDVHSequence()

Returns:

whether it contains the DVH Sequence (see DVHSequence)

removeDVHSequence

default void removeDVHSequence()

Removes the DVH Sequence (see DVHSequence