Package org.dcm4che.typeddicom.dataelements

Interface ContainerComponentSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

SpecimenModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, CRImageIOD, CTImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, MicroscopyBulkSimpleAnnotationsIOD, MRImageIOD, MRSpectroscopyIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, ParametricMapIOD, PETImageIOD, RawDataIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, ScheduledSpecimenSequence.Item, SecondaryCaptureImageIOD, SegmentationIOD, SpecimenModule.SimpleWrapper, SurfaceScanMeshIOD, SurfaceScanPointCloudIOD, TractographyResultsIOD, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

ContainerComponentSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Container Component Sequence" (see ContainerComponentSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContainerComponentSequence.Holder.Builder	builder()
static ContainerComponentSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsContainerComponentSequence()
default ContainerComponentSequence	ensureContainerComponentSequence()	Adds a new Container Component Sequence (see ContainerComponentSequence) with initial capacity 1 (see ensureContainerComponentSequence(int)) if it does not already exist.
default ContainerComponentSequence	ensureContainerComponentSequence(int initialCapacity)	Adds a new Container Component Sequence (see ContainerComponentSequence) if it does not already exist.
default ContainerComponentSequence	getContainerComponentSequence()
default ContainerComponentSequence	newContainerComponentSequence(int initialCapacity)	Adds a new Container Component Sequence.
default void	removeContainerComponentSequence()	Removes the Container Component Sequence (see ContainerComponentSequence
static ContainerComponentSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Container Component Sequence (see ContainerComponentSequence)

Returns:

a wrapper object implementing the ContainerComponentSequence.Holder interface.

builder

static ContainerComponentSequence.Holder.Builder builder()

Returns:

a ContainerComponentSequence.Holder.Builder to create Container Component Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ContainerComponentSequence.Holder.Builder to create Container Component Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getContainerComponentSequence

default ContainerComponentSequence getContainerComponentSequence()

Returns:

the Container Component Sequence (see ContainerComponentSequence)

newContainerComponentSequence

default ContainerComponentSequence newContainerComponentSequence(int initialCapacity)

Adds a new Container Component Sequence. (see ContainerComponentSequence)

Parameters:

initialCapacity - the initial capacity for the new Container Component Sequence

Returns:

the newly created ContainerComponentSequence.

ensureContainerComponentSequence

default ContainerComponentSequence ensureContainerComponentSequence(int initialCapacity)

Adds a new Container Component Sequence (see ContainerComponentSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Container Component Sequence (see ContainerComponentSequence) or a new one with capacity initialCapacity.

ensureContainerComponentSequence

default ContainerComponentSequence ensureContainerComponentSequence()

Adds a new Container Component Sequence (see ContainerComponentSequence) with initial capacity 1 (see ensureContainerComponentSequence(int)) if it does not already exist.

Returns:

either the already existing Container Component Sequence (see ContainerComponentSequence) or a new one with capacity 1.

containsContainerComponentSequence

default boolean containsContainerComponentSequence()

Returns:

whether it contains the Container Component Sequence (see ContainerComponentSequence)

removeContainerComponentSequence

default void removeContainerComponentSequence()

Removes the Container Component Sequence (see ContainerComponentSequence