Package org.dcm4che.typeddicom.dataelements

Interface DimensionOrganizationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MultiFrameDimensionModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedRTImageIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, IntravascularOpticalCoherenceTomographyImageIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, MRSpectroscopyIOD, MultiFrameDimensionModule.SimpleWrapper, MultiFrameGrayscaleByteSecondaryCaptureImageIOD, MultiFrameGrayscaleWordSecondaryCaptureImageIOD, MultiFrameTrueColorSecondaryCaptureImageIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicTomographyImageIOD, ParametricMapIOD, SegmentationIOD, VLWholeSlideMicroscopyImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD

Enclosing class:

DimensionOrganizationSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DimensionOrganizationSequence.Holder.Builder	builder()
static DimensionOrganizationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDimensionOrganizationSequence()
default DimensionOrganizationSequence	ensureDimensionOrganizationSequence()	Adds a new Dimension Organization Sequence (see DimensionOrganizationSequence) with initial capacity 1 (see ensureDimensionOrganizationSequence(int)) if it does not already exist.
default DimensionOrganizationSequence	ensureDimensionOrganizationSequence(int initialCapacity)	Adds a new Dimension Organization Sequence (see DimensionOrganizationSequence) if it does not already exist.
default DimensionOrganizationSequence	getDimensionOrganizationSequence()
default DimensionOrganizationSequence	newDimensionOrganizationSequence(int initialCapacity)	Adds a new Dimension Organization Sequence.
default void	removeDimensionOrganizationSequence()	Removes the Dimension Organization Sequence (see DimensionOrganizationSequence
static DimensionOrganizationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Dimension Organization Sequence (see DimensionOrganizationSequence)

Returns:

a wrapper object implementing the DimensionOrganizationSequence.Holder interface.

builder

static DimensionOrganizationSequence.Holder.Builder builder()

Returns:

a DimensionOrganizationSequence.Holder.Builder to create Dimension Organization Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDimensionOrganizationSequence

default DimensionOrganizationSequence getDimensionOrganizationSequence()

Returns:

the Dimension Organization Sequence (see DimensionOrganizationSequence)

newDimensionOrganizationSequence

default DimensionOrganizationSequence newDimensionOrganizationSequence(int initialCapacity)

Adds a new Dimension Organization Sequence. (see DimensionOrganizationSequence)

Parameters:

initialCapacity - the initial capacity for the new Dimension Organization Sequence

Returns:

the newly created DimensionOrganizationSequence.

ensureDimensionOrganizationSequence

default DimensionOrganizationSequence ensureDimensionOrganizationSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureDimensionOrganizationSequence

default DimensionOrganizationSequence ensureDimensionOrganizationSequence()

Adds a new Dimension Organization Sequence (see DimensionOrganizationSequence) with initial capacity 1 (see ensureDimensionOrganizationSequence(int)) if it does not already exist.

Returns:

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

containsDimensionOrganizationSequence

default boolean containsDimensionOrganizationSequence()

Returns:

whether it contains the Dimension Organization Sequence (see DimensionOrganizationSequence)

removeDimensionOrganizationSequence

default void removeDimensionOrganizationSequence()

Removes the Dimension Organization Sequence (see DimensionOrganizationSequence