Package org.dcm4che.typeddicom.dataelements

Interface IconImageSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

EnhancedCTImageModule, EnhancedMammographyImageModule, EnhancedMRImageModule, EnhancedPETImageModule, EnhancedUSImageModule, EnhancedXAXRFImageModuleTable, GeneralImageModule, Manufacturing3DModelModule, StructuredDisplayModule, XRay3DImageModule

All Known Implementing Classes:

BasicStructuredDisplayIOD, BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, ComputedRadiographyImageIOD, CornealTopographyMapIOD, CTImageIOD, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedSTLIOD, EnhancedCTImageIOD, EnhancedCTImageModule.SimpleWrapper, EnhancedMammographyImageModule.SimpleWrapper, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedMRImageModule.SimpleWrapper, EnhancedPETImageIOD, EnhancedPETImageModule.SimpleWrapper, EnhancedUSImageModule.SimpleWrapper, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXAXRFImageModuleTable.SimpleWrapper, EnhancedXRFImageIOD, GeneralImageModule.SimpleWrapper, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, Manufacturing3DModelModule.SimpleWrapper, MRImageIOD, MultiFrameGrayscaleByteSecondaryCaptureImageIOD, MultiFrameGrayscaleWordSecondaryCaptureImageIOD, MultiFrameSingleBitSecondaryCaptureImageIOD, MultiFrameTrueColorSecondaryCaptureImageIOD, NuclearMedicineImageIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, ParametricMapIOD, PositronEmissionTomographyImageIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, ReferencedSOPSequence.Item, RTDoseIOD, RTImageIOD, SecondaryCaptureImageIOD, SegmentationIOD, StructuredDisplayModule.SimpleWrapper, UltrasoundImageIOD, UltrasoundMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRay3DImageModule.SimpleWrapper, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

IconImageSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Icon Image Sequence" (see IconImageSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IconImageSequence.Holder.Builder	builder()
static IconImageSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsIconImageSequence()
default IconImageSequence	ensureIconImageSequence()	Adds a new Icon Image Sequence (see IconImageSequence) with initial capacity 1 (see ensureIconImageSequence(int)) if it does not already exist.
default IconImageSequence	ensureIconImageSequence(int initialCapacity)	Adds a new Icon Image Sequence (see IconImageSequence) if it does not already exist.
default IconImageSequence	getIconImageSequence()
default IconImageSequence	newIconImageSequence(int initialCapacity)	Adds a new Icon Image Sequence.
default void	removeIconImageSequence()	Removes the Icon Image Sequence (see IconImageSequence
static IconImageSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Icon Image Sequence (see IconImageSequence)

Returns:

a wrapper object implementing the IconImageSequence.Holder interface.

builder

static IconImageSequence.Holder.Builder builder()

Returns:

a IconImageSequence.Holder.Builder to create Icon Image Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a IconImageSequence.Holder.Builder to create Icon Image Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getIconImageSequence

default IconImageSequence getIconImageSequence()

Returns:

the Icon Image Sequence (see IconImageSequence)

newIconImageSequence

default IconImageSequence newIconImageSequence(int initialCapacity)

Adds a new Icon Image Sequence. (see IconImageSequence)

Parameters:

initialCapacity - the initial capacity for the new Icon Image Sequence

Returns:

the newly created IconImageSequence.

ensureIconImageSequence

default IconImageSequence ensureIconImageSequence(int initialCapacity)

Adds a new Icon Image Sequence (see IconImageSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Icon Image Sequence (see IconImageSequence) or a new one with capacity initialCapacity.

ensureIconImageSequence

default IconImageSequence ensureIconImageSequence()

Adds a new Icon Image Sequence (see IconImageSequence) with initial capacity 1 (see ensureIconImageSequence(int)) if it does not already exist.

Returns:

either the already existing Icon Image Sequence (see IconImageSequence) or a new one with capacity 1.

containsIconImageSequence

default boolean containsIconImageSequence()

Returns:

whether it contains the Icon Image Sequence (see IconImageSequence)

removeIconImageSequence

default void removeIconImageSequence()

Removes the Icon Image Sequence (see IconImageSequence