Package org.dcm4che.typeddicom.dataelements

Interface DeviceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

DeviceModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, CRImageIOD, CTImageIOD, DeviceModule.SimpleWrapper, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, IntravascularOpticalCoherenceTomographyImageIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, MRImageIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, ParametricMapIOD, PETImageIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RTImageIOD, SecondaryCaptureImageIOD, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

DeviceSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Device Sequence" (see DeviceSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DeviceSequence.Holder.Builder	builder()
static DeviceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDeviceSequence()
default DeviceSequence	ensureDeviceSequence()	Adds a new Device Sequence (see DeviceSequence) with initial capacity 1 (see ensureDeviceSequence(int)) if it does not already exist.
default DeviceSequence	ensureDeviceSequence(int initialCapacity)	Adds a new Device Sequence (see DeviceSequence) if it does not already exist.
default DeviceSequence	getDeviceSequence()
default DeviceSequence	newDeviceSequence(int initialCapacity)	Adds a new Device Sequence.
default void	removeDeviceSequence()	Removes the Device Sequence (see DeviceSequence
static DeviceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Device Sequence (see DeviceSequence)

Returns:

a wrapper object implementing the DeviceSequence.Holder interface.

builder

static DeviceSequence.Holder.Builder builder()

Returns:

a DeviceSequence.Holder.Builder to create Device Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDeviceSequence

default DeviceSequence getDeviceSequence()

Returns:

the Device Sequence (see DeviceSequence)

newDeviceSequence

default DeviceSequence newDeviceSequence(int initialCapacity)

Adds a new Device Sequence. (see DeviceSequence)

Parameters:

initialCapacity - the initial capacity for the new Device Sequence

Returns:

the newly created DeviceSequence.

ensureDeviceSequence

default DeviceSequence ensureDeviceSequence(int initialCapacity)

Adds a new Device Sequence (see DeviceSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Device Sequence (see DeviceSequence) or a new one with capacity initialCapacity.

ensureDeviceSequence

default DeviceSequence ensureDeviceSequence()

Adds a new Device Sequence (see DeviceSequence) with initial capacity 1 (see ensureDeviceSequence(int)) if it does not already exist.

Returns:

either the already existing Device Sequence (see DeviceSequence) or a new one with capacity 1.

containsDeviceSequence

default boolean containsDeviceSequence()

Returns:

whether it contains the Device Sequence (see DeviceSequence)

removeDeviceSequence

default void removeDeviceSequence()

Removes the Device Sequence (see DeviceSequence