Package org.dcm4che.typeddicom.dataelements

Interface VolumetricAnnotationSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

VolumetricGraphicAnnotationModule

All Known Implementing Classes:

PlanarMPRVolumetricPresentationStateIOD, VolumeRenderingVolumetricPresentationStateIOD, VolumetricAnnotationSequence.SimpleHolder

Enclosing class:

VolumetricAnnotationSequence

public static interface VolumetricAnnotationSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Volumetric Annotation Sequence" (see VolumetricAnnotationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VolumetricAnnotationSequence.Holder.Builder	builder()
static VolumetricAnnotationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsVolumetricAnnotationSequence()
default VolumetricAnnotationSequence	ensureVolumetricAnnotationSequence()	Adds a new Volumetric Annotation Sequence (see VolumetricAnnotationSequence) with initial capacity 1 (see ensureVolumetricAnnotationSequence(int)) if it does not already exist.
default VolumetricAnnotationSequence	ensureVolumetricAnnotationSequence(int initialCapacity)	Adds a new Volumetric Annotation Sequence (see VolumetricAnnotationSequence) if it does not already exist.
default VolumetricAnnotationSequence	getVolumetricAnnotationSequence()
default VolumetricAnnotationSequence	newVolumetricAnnotationSequence(int initialCapacity)	Adds a new Volumetric Annotation Sequence.
default void	removeVolumetricAnnotationSequence()	Removes the Volumetric Annotation Sequence (see VolumetricAnnotationSequence
static VolumetricAnnotationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Volumetric Annotation Sequence (see VolumetricAnnotationSequence)

Returns:

A wrapper object implementing the VolumetricAnnotationSequence.Holder interface.

builder

static VolumetricAnnotationSequence.Holder.Builder builder()

Returns:

a VolumetricAnnotationSequence.Holder.Builder to create Volumetric Annotation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getVolumetricAnnotationSequence

default VolumetricAnnotationSequence getVolumetricAnnotationSequence()

Returns:

the Volumetric Annotation Sequence (see VolumetricAnnotationSequence)

newVolumetricAnnotationSequence

default VolumetricAnnotationSequence newVolumetricAnnotationSequence(int initialCapacity)

Adds a new Volumetric Annotation Sequence. (see VolumetricAnnotationSequence)

Parameters:

initialCapacity - the initial capacity for the new Volumetric Annotation Sequence

ensureVolumetricAnnotationSequence

default VolumetricAnnotationSequence ensureVolumetricAnnotationSequence(int initialCapacity)

Adds a new Volumetric Annotation Sequence (see VolumetricAnnotationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

Either the already existing Volumetric Annotation Sequence (see VolumetricAnnotationSequence) or a new one with capacity initialCapacity.

ensureVolumetricAnnotationSequence

default VolumetricAnnotationSequence ensureVolumetricAnnotationSequence()

Adds a new Volumetric Annotation Sequence (see VolumetricAnnotationSequence) with initial capacity 1 (see ensureVolumetricAnnotationSequence(int)) if it does not already exist.

Returns:

Either the already existing Volumetric Annotation Sequence (see VolumetricAnnotationSequence) or a new one with capacity 1.

containsVolumetricAnnotationSequence

default boolean containsVolumetricAnnotationSequence()

Returns:

Whether it contains the Volumetric Annotation Sequence (see VolumetricAnnotationSequence)

removeVolumetricAnnotationSequence

default void removeVolumetricAnnotationSequence()

Removes the Volumetric Annotation Sequence (see VolumetricAnnotationSequence