Package org.dcm4che.typeddicom.dataelements

Interface VolumeCroppingSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

VolumeCroppingModule

All Known Implementing Classes:

PlanarMPRVolumetricPresentationStateIOD, VolumeCroppingModule.SimpleWrapper, VolumeRenderingVolumetricPresentationStateIOD

Enclosing class:

VolumeCroppingSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Volume Cropping Sequence" (see VolumeCroppingSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VolumeCroppingSequence.Holder.Builder	builder()
static VolumeCroppingSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsVolumeCroppingSequence()
default VolumeCroppingSequence	ensureVolumeCroppingSequence()	Adds a new Volume Cropping Sequence (see VolumeCroppingSequence) with initial capacity 1 (see ensureVolumeCroppingSequence(int)) if it does not already exist.
default VolumeCroppingSequence	ensureVolumeCroppingSequence(int initialCapacity)	Adds a new Volume Cropping Sequence (see VolumeCroppingSequence) if it does not already exist.
default VolumeCroppingSequence	getVolumeCroppingSequence()
default VolumeCroppingSequence	newVolumeCroppingSequence(int initialCapacity)	Adds a new Volume Cropping Sequence.
default void	removeVolumeCroppingSequence()	Removes the Volume Cropping Sequence (see VolumeCroppingSequence
static VolumeCroppingSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Volume Cropping Sequence (see VolumeCroppingSequence)

Returns:

a wrapper object implementing the VolumeCroppingSequence.Holder interface.

builder

static VolumeCroppingSequence.Holder.Builder builder()

Returns:

a VolumeCroppingSequence.Holder.Builder to create Volume Cropping Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getVolumeCroppingSequence

default VolumeCroppingSequence getVolumeCroppingSequence()

Returns:

the Volume Cropping Sequence (see VolumeCroppingSequence)

newVolumeCroppingSequence

default VolumeCroppingSequence newVolumeCroppingSequence(int initialCapacity)

Adds a new Volume Cropping Sequence. (see VolumeCroppingSequence)

Parameters:

initialCapacity - the initial capacity for the new Volume Cropping Sequence

Returns:

the newly created VolumeCroppingSequence.

ensureVolumeCroppingSequence

default VolumeCroppingSequence ensureVolumeCroppingSequence(int initialCapacity)

Adds a new Volume Cropping Sequence (see VolumeCroppingSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Volume Cropping Sequence (see VolumeCroppingSequence) or a new one with capacity initialCapacity.

ensureVolumeCroppingSequence

default VolumeCroppingSequence ensureVolumeCroppingSequence()

Adds a new Volume Cropping Sequence (see VolumeCroppingSequence) with initial capacity 1 (see ensureVolumeCroppingSequence(int)) if it does not already exist.

Returns:

either the already existing Volume Cropping Sequence (see VolumeCroppingSequence) or a new one with capacity 1.

containsVolumeCroppingSequence

default boolean containsVolumeCroppingSequence()

Returns:

whether it contains the Volume Cropping Sequence (see VolumeCroppingSequence)

removeVolumeCroppingSequence

default void removeVolumeCroppingSequence()

Removes the Volume Cropping Sequence (see VolumeCroppingSequence