Package org.dcm4che.typeddicom.dataelements

Interface VolumeLocalizationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MRSpectroscopyModule

All Known Implementing Classes:

MRSpectroscopyIOD, VolumeLocalizationSequence.SimpleHolder

Enclosing class:

VolumeLocalizationSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VolumeLocalizationSequence.Holder.Builder	builder()
static VolumeLocalizationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsVolumeLocalizationSequence()
default VolumeLocalizationSequence	ensureVolumeLocalizationSequence()	Adds a new Volume Localization Sequence (see VolumeLocalizationSequence) with initial capacity 1 (see ensureVolumeLocalizationSequence(int)) if it does not already exist.
default VolumeLocalizationSequence	ensureVolumeLocalizationSequence(int initialCapacity)	Adds a new Volume Localization Sequence (see VolumeLocalizationSequence) if it does not already exist.
default VolumeLocalizationSequence	getVolumeLocalizationSequence()
default VolumeLocalizationSequence	newVolumeLocalizationSequence(int initialCapacity)	Adds a new Volume Localization Sequence.
default void	removeVolumeLocalizationSequence()	Removes the Volume Localization Sequence (see VolumeLocalizationSequence
static VolumeLocalizationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Volume Localization Sequence (see VolumeLocalizationSequence)

Returns:

a wrapper object implementing the VolumeLocalizationSequence.Holder interface.

builder

static VolumeLocalizationSequence.Holder.Builder builder()

Returns:

a VolumeLocalizationSequence.Holder.Builder to create Volume Localization Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getVolumeLocalizationSequence

default VolumeLocalizationSequence getVolumeLocalizationSequence()

Returns:

the Volume Localization Sequence (see VolumeLocalizationSequence)

newVolumeLocalizationSequence

default VolumeLocalizationSequence newVolumeLocalizationSequence(int initialCapacity)

Adds a new Volume Localization Sequence. (see VolumeLocalizationSequence)

Parameters:

initialCapacity - the initial capacity for the new Volume Localization Sequence

Returns:

the newly created VolumeLocalizationSequence.

ensureVolumeLocalizationSequence

default VolumeLocalizationSequence ensureVolumeLocalizationSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureVolumeLocalizationSequence

default VolumeLocalizationSequence ensureVolumeLocalizationSequence()

Adds a new Volume Localization Sequence (see VolumeLocalizationSequence) with initial capacity 1 (see ensureVolumeLocalizationSequence(int)) if it does not already exist.

Returns:

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

containsVolumeLocalizationSequence

default boolean containsVolumeLocalizationSequence()

Returns:

whether it contains the Volume Localization Sequence (see VolumeLocalizationSequence)

removeVolumeLocalizationSequence

default void removeVolumeLocalizationSequence()

Removes the Volume Localization Sequence (see VolumeLocalizationSequence