Package org.dcm4che.typeddicom.dataelements

Interface InterventionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

InterventionModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, EnhancedPETImageIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, InterventionModule.SimpleWrapper, LegacyConvertedEnhancedPETImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

InterventionSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InterventionSequence.Holder.Builder	builder()
static InterventionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsInterventionSequence()
default InterventionSequence	ensureInterventionSequence()	Adds a new Intervention Sequence (see InterventionSequence) with initial capacity 1 (see ensureInterventionSequence(int)) if it does not already exist.
default InterventionSequence	ensureInterventionSequence(int initialCapacity)	Adds a new Intervention Sequence (see InterventionSequence) if it does not already exist.
default InterventionSequence	getInterventionSequence()
default InterventionSequence	newInterventionSequence(int initialCapacity)	Adds a new Intervention Sequence.
default void	removeInterventionSequence()	Removes the Intervention Sequence (see InterventionSequence
static InterventionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Intervention Sequence (see InterventionSequence)

Returns:

a wrapper object implementing the InterventionSequence.Holder interface.

builder

static InterventionSequence.Holder.Builder builder()

Returns:

a InterventionSequence.Holder.Builder to create Intervention Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getInterventionSequence

default InterventionSequence getInterventionSequence()

Returns:

the Intervention Sequence (see InterventionSequence)

newInterventionSequence

default InterventionSequence newInterventionSequence(int initialCapacity)

Adds a new Intervention Sequence. (see InterventionSequence)

Parameters:

initialCapacity - the initial capacity for the new Intervention Sequence

Returns:

the newly created InterventionSequence.

ensureInterventionSequence

default InterventionSequence ensureInterventionSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureInterventionSequence

default InterventionSequence ensureInterventionSequence()

Adds a new Intervention Sequence (see InterventionSequence) with initial capacity 1 (see ensureInterventionSequence(int)) if it does not already exist.

Returns:

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

containsInterventionSequence

default boolean containsInterventionSequence()

Returns:

whether it contains the Intervention Sequence (see InterventionSequence)

removeInterventionSequence

default void removeInterventionSequence()

Removes the Intervention Sequence (see InterventionSequence