Package org.dcm4che.typeddicom.dataelements

Interface FixationSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

VisualFieldStaticPerimetryTestReliabilityModule

All Known Implementing Classes:

FixationSequence.SimpleHolder, OphthalmicVisualFieldStaticPerimetryMeasurementsIOD

Enclosing class:

FixationSequence

public static interface FixationSequence.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FixationSequence.Holder.Builder	builder()
static FixationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFixationSequence()
default FixationSequence	ensureFixationSequence()	Adds a new Fixation Sequence (see FixationSequence) with initial capacity 1 (see ensureFixationSequence(int)) if it does not already exist.
default FixationSequence	ensureFixationSequence(int initialCapacity)	Adds a new Fixation Sequence (see FixationSequence) if it does not already exist.
default FixationSequence	getFixationSequence()
default FixationSequence	newFixationSequence(int initialCapacity)	Adds a new Fixation Sequence.
default void	removeFixationSequence()	Removes the Fixation Sequence (see FixationSequence
static FixationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Fixation Sequence (see FixationSequence)

Returns:

A wrapper object implementing the FixationSequence.Holder interface.

builder

static FixationSequence.Holder.Builder builder()

Returns:

a FixationSequence.Holder.Builder to create Fixation Sequence Items with a fluent API.

builder

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

Parameters:

attributes - The Attributes to be wrapped by the FixationSequence.Holder.Builder.

Returns:

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

getFixationSequence

default FixationSequence getFixationSequence()

Returns:

the Fixation Sequence (see FixationSequence)

newFixationSequence

default FixationSequence newFixationSequence(int initialCapacity)

Adds a new Fixation Sequence. (see FixationSequence)

Parameters:

initialCapacity - the initial capacity for the new Fixation Sequence

ensureFixationSequence

default FixationSequence ensureFixationSequence(int initialCapacity)

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

Parameters:

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

Returns:

Either the already existing Fixation Sequence (see FixationSequence) or a new one with capacity initialCapacity.

ensureFixationSequence

default FixationSequence ensureFixationSequence()

Adds a new Fixation Sequence (see FixationSequence) with initial capacity 1 (see ensureFixationSequence(int)) if it does not already exist.

Returns:

Either the already existing Fixation Sequence (see FixationSequence) or a new one with capacity 1.

containsFixationSequence

default boolean containsFixationSequence()

Returns:

Whether it contains the Fixation Sequence (see FixationSequence)

removeFixationSequence

default void removeFixationSequence()

Removes the Fixation Sequence (see FixationSequence