Package org.dcm4che.typeddicom.dataelements

Interface ViewCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

BreastViewModule, CTImageModule, DXPositioningModule, EnhancedCTImageModule, EnhancedMRImageModule, EnhancedPETAcquisitionModule, EnhancedUSImageModule, MammographyImageModule, MRImageModule, PETImageModule, PresentationViewDescriptionModule, SCImageModule, USImageModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, BreastViewModule.SimpleWrapper, CTImageIOD, CTImageModule.SimpleWrapper, DetectorInformationSequence.Item, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, DXPositioningModule.SimpleWrapper, EnhancedCTImageIOD, EnhancedCTImageModule.SimpleWrapper, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedMRImageModule.SimpleWrapper, EnhancedPETAcquisitionModule.SimpleWrapper, EnhancedPETImageIOD, EnhancedUSImageModule.SimpleWrapper, EnhancedUSVolumeIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, MammographyImageModule.SimpleWrapper, MRImageIOD, MRImageModule.SimpleWrapper, MultiFrameGrayscaleByteSecondaryCaptureImageIOD, MultiFrameGrayscaleWordSecondaryCaptureImageIOD, MultiFrameSingleBitSecondaryCaptureImageIOD, MultiFrameTrueColorSecondaryCaptureImageIOD, PETImageModule.SimpleWrapper, PlanarMPRVolumetricPresentationStateIOD, PositronEmissionTomographyImageIOD, PresentationViewDescriptionModule.SimpleWrapper, SCImageModule.SimpleWrapper, SecondaryCaptureImageIOD, UltrasoundImageIOD, UltrasoundMultiFrameImageIOD, USImageModule.SimpleWrapper, VolumeRenderingVolumetricPresentationStateIOD

Enclosing class:

ViewCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "View Code Sequence" (see ViewCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ViewCodeSequence.Holder.Builder	builder()
static ViewCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsViewCodeSequence()
default ViewCodeSequence	ensureViewCodeSequence()	Adds a new View Code Sequence (see ViewCodeSequence) with initial capacity 1 (see ensureViewCodeSequence(int)) if it does not already exist.
default ViewCodeSequence	ensureViewCodeSequence(int initialCapacity)	Adds a new View Code Sequence (see ViewCodeSequence) if it does not already exist.
default ViewCodeSequence	getViewCodeSequence()
default ViewCodeSequence	newViewCodeSequence(int initialCapacity)	Adds a new View Code Sequence.
default void	removeViewCodeSequence()	Removes the View Code Sequence (see ViewCodeSequence
static ViewCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the View Code Sequence (see ViewCodeSequence)

Returns:

a wrapper object implementing the ViewCodeSequence.Holder interface.

builder

static ViewCodeSequence.Holder.Builder builder()

Returns:

a ViewCodeSequence.Holder.Builder to create View Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ViewCodeSequence.Holder.Builder to create View Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getViewCodeSequence

default ViewCodeSequence getViewCodeSequence()

Returns:

the View Code Sequence (see ViewCodeSequence)

newViewCodeSequence

default ViewCodeSequence newViewCodeSequence(int initialCapacity)

Adds a new View Code Sequence. (see ViewCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new View Code Sequence

Returns:

the newly created ViewCodeSequence.

ensureViewCodeSequence

default ViewCodeSequence ensureViewCodeSequence(int initialCapacity)

Adds a new View Code Sequence (see ViewCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing View Code Sequence (see ViewCodeSequence) or a new one with capacity initialCapacity.

ensureViewCodeSequence

default ViewCodeSequence ensureViewCodeSequence()

Adds a new View Code Sequence (see ViewCodeSequence) with initial capacity 1 (see ensureViewCodeSequence(int)) if it does not already exist.

Returns:

either the already existing View Code Sequence (see ViewCodeSequence) or a new one with capacity 1.

containsViewCodeSequence

default boolean containsViewCodeSequence()

Returns:

whether it contains the View Code Sequence (see ViewCodeSequence)

removeViewCodeSequence

default void removeViewCodeSequence()

Removes the View Code Sequence (see ViewCodeSequence