Package org.dcm4che.typeddicom.dataelements

Interface DimensionIndexSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MultiFrameDimensionModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, DimensionIndexSequence.SimpleHolder, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, IntravascularOpticalCoherenceTomographyImageIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, MRSpectroscopyIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameTrueColorSCImageIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicTomographyImageIOD, ParametricMapIOD, SegmentationIOD, VLWholeSlideMicroscopyImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD

Enclosing class:

DimensionIndexSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Dimension Index Sequence" (see DimensionIndexSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DimensionIndexSequence.Holder.Builder	builder()
static DimensionIndexSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDimensionIndexSequence()
default DimensionIndexSequence	ensureDimensionIndexSequence()	Adds a new Dimension Index Sequence (see DimensionIndexSequence) with initial capacity 1 (see ensureDimensionIndexSequence(int)) if it does not already exist.
default DimensionIndexSequence	ensureDimensionIndexSequence(int initialCapacity)	Adds a new Dimension Index Sequence (see DimensionIndexSequence) if it does not already exist.
default DimensionIndexSequence	getDimensionIndexSequence()
default DimensionIndexSequence	newDimensionIndexSequence(int initialCapacity)	Adds a new Dimension Index Sequence.
default void	removeDimensionIndexSequence()	Removes the Dimension Index Sequence (see DimensionIndexSequence
static DimensionIndexSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Dimension Index Sequence (see DimensionIndexSequence)

Returns:

a wrapper object implementing the DimensionIndexSequence.Holder interface.

builder

static DimensionIndexSequence.Holder.Builder builder()

Returns:

a DimensionIndexSequence.Holder.Builder to create Dimension Index Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDimensionIndexSequence

default DimensionIndexSequence getDimensionIndexSequence()

Returns:

the Dimension Index Sequence (see DimensionIndexSequence)

newDimensionIndexSequence

default DimensionIndexSequence newDimensionIndexSequence(int initialCapacity)

Adds a new Dimension Index Sequence. (see DimensionIndexSequence)

Parameters:

initialCapacity - the initial capacity for the new Dimension Index Sequence

Returns:

the newly created DimensionIndexSequence.

ensureDimensionIndexSequence

default DimensionIndexSequence ensureDimensionIndexSequence(int initialCapacity)

Adds a new Dimension Index Sequence (see DimensionIndexSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Dimension Index Sequence (see DimensionIndexSequence) or a new one with capacity initialCapacity.

ensureDimensionIndexSequence

default DimensionIndexSequence ensureDimensionIndexSequence()

Adds a new Dimension Index Sequence (see DimensionIndexSequence) with initial capacity 1 (see ensureDimensionIndexSequence(int)) if it does not already exist.

Returns:

either the already existing Dimension Index Sequence (see DimensionIndexSequence) or a new one with capacity 1.

containsDimensionIndexSequence

default boolean containsDimensionIndexSequence()

Returns:

whether it contains the Dimension Index Sequence (see DimensionIndexSequence)

removeDimensionIndexSequence

default void removeDimensionIndexSequence()

Removes the Dimension Index Sequence (see DimensionIndexSequence