Package org.dcm4che.typeddicom.dataelements

Interface OpticalPathSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

OpticalPathModule

All Known Implementing Classes:

OpticalPathModule.SimpleWrapper, VLMicroscopicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD

Enclosing class:

OpticalPathSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Optical Path Sequence" (see OpticalPathSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OpticalPathSequence.Holder.Builder	builder()
static OpticalPathSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOpticalPathSequence()
default OpticalPathSequence	ensureOpticalPathSequence()	Adds a new Optical Path Sequence (see OpticalPathSequence) with initial capacity 1 (see ensureOpticalPathSequence(int)) if it does not already exist.
default OpticalPathSequence	ensureOpticalPathSequence(int initialCapacity)	Adds a new Optical Path Sequence (see OpticalPathSequence) if it does not already exist.
default OpticalPathSequence	getOpticalPathSequence()
default OpticalPathSequence	newOpticalPathSequence(int initialCapacity)	Adds a new Optical Path Sequence.
default void	removeOpticalPathSequence()	Removes the Optical Path Sequence (see OpticalPathSequence
static OpticalPathSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Optical Path Sequence (see OpticalPathSequence)

Returns:

a wrapper object implementing the OpticalPathSequence.Holder interface.

builder

static OpticalPathSequence.Holder.Builder builder()

Returns:

a OpticalPathSequence.Holder.Builder to create Optical Path Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getOpticalPathSequence

default OpticalPathSequence getOpticalPathSequence()

Returns:

the Optical Path Sequence (see OpticalPathSequence)

newOpticalPathSequence

default OpticalPathSequence newOpticalPathSequence(int initialCapacity)

Adds a new Optical Path Sequence. (see OpticalPathSequence)

Parameters:

initialCapacity - the initial capacity for the new Optical Path Sequence

Returns:

the newly created OpticalPathSequence.

ensureOpticalPathSequence

default OpticalPathSequence ensureOpticalPathSequence(int initialCapacity)

Adds a new Optical Path Sequence (see OpticalPathSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Optical Path Sequence (see OpticalPathSequence) or a new one with capacity initialCapacity.

ensureOpticalPathSequence

default OpticalPathSequence ensureOpticalPathSequence()

Adds a new Optical Path Sequence (see OpticalPathSequence) with initial capacity 1 (see ensureOpticalPathSequence(int)) if it does not already exist.

Returns:

either the already existing Optical Path Sequence (see OpticalPathSequence) or a new one with capacity 1.

containsOpticalPathSequence

default boolean containsOpticalPathSequence()

Returns:

whether it contains the Optical Path Sequence (see OpticalPathSequence)

removeOpticalPathSequence

default void removeOpticalPathSequence()

Removes the Optical Path Sequence (see OpticalPathSequence