Package org.dcm4che.typeddicom.dataelements

Interface SharedFunctionalGroupsSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MultiFrameFunctionalGroupsModule, RealTimeAcquisitionModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, IntravascularOpticalCoherenceTomographyImageIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, MRSpectroscopyIOD, MultiFrameFunctionalGroupsModule.SimpleWrapper, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameTrueColorSCImageIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicTomographyImageIOD, ParametricMapIOD, RealTimeAcquisitionModule.SimpleWrapper, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, SegmentationIOD, VLWholeSlideMicroscopyImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD

Enclosing class:

SharedFunctionalGroupsSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Shared Functional Groups Sequence" (see SharedFunctionalGroupsSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SharedFunctionalGroupsSequence.Holder.Builder	builder()
static SharedFunctionalGroupsSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSharedFunctionalGroupsSequence()
default SharedFunctionalGroupsSequence	ensureSharedFunctionalGroupsSequence()	Adds a new Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence) with initial capacity 1 (see ensureSharedFunctionalGroupsSequence(int)) if it does not already exist.
default SharedFunctionalGroupsSequence	ensureSharedFunctionalGroupsSequence(int initialCapacity)	Adds a new Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence) if it does not already exist.
default SharedFunctionalGroupsSequence	getSharedFunctionalGroupsSequence()
default SharedFunctionalGroupsSequence	newSharedFunctionalGroupsSequence(int initialCapacity)	Adds a new Shared Functional Groups Sequence.
default void	removeSharedFunctionalGroupsSequence()	Removes the Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence
static SharedFunctionalGroupsSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence)

Returns:

a wrapper object implementing the SharedFunctionalGroupsSequence.Holder interface.

builder

static SharedFunctionalGroupsSequence.Holder.Builder builder()

Returns:

a SharedFunctionalGroupsSequence.Holder.Builder to create Shared Functional Groups Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a SharedFunctionalGroupsSequence.Holder.Builder to create Shared Functional Groups Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getSharedFunctionalGroupsSequence

default SharedFunctionalGroupsSequence getSharedFunctionalGroupsSequence()

Returns:

the Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence)

newSharedFunctionalGroupsSequence

default SharedFunctionalGroupsSequence newSharedFunctionalGroupsSequence(int initialCapacity)

Adds a new Shared Functional Groups Sequence. (see SharedFunctionalGroupsSequence)

Parameters:

initialCapacity - the initial capacity for the new Shared Functional Groups Sequence

Returns:

the newly created SharedFunctionalGroupsSequence.

ensureSharedFunctionalGroupsSequence

default SharedFunctionalGroupsSequence ensureSharedFunctionalGroupsSequence(int initialCapacity)

Adds a new Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Shared Functional Groups Sequence is created.

Returns:

either the already existing Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence) or a new one with capacity initialCapacity.

ensureSharedFunctionalGroupsSequence

default SharedFunctionalGroupsSequence ensureSharedFunctionalGroupsSequence()

Adds a new Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence) with initial capacity 1 (see ensureSharedFunctionalGroupsSequence(int)) if it does not already exist.

Returns:

either the already existing Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence) or a new one with capacity 1.

containsSharedFunctionalGroupsSequence

default boolean containsSharedFunctionalGroupsSequence()

Returns:

whether it contains the Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence)

removeSharedFunctionalGroupsSequence

default void removeSharedFunctionalGroupsSequence()

Removes the Shared Functional Groups Sequence (see SharedFunctionalGroupsSequence