Package org.dcm4che.typeddicom.dataelements

Interface IndexProbabilitySequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

VisualFieldGlobalResultsIndexSequence.Item, VisualFieldTestReliabilityGlobalIndexSequence.Item

Enclosing class:

IndexProbabilitySequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Index Probability Sequence" (see IndexProbabilitySequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IndexProbabilitySequence.Holder.Builder	builder()
static IndexProbabilitySequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsIndexProbabilitySequence()
default IndexProbabilitySequence	ensureIndexProbabilitySequence()	Adds a new Index Probability Sequence (see IndexProbabilitySequence) with initial capacity 1 (see ensureIndexProbabilitySequence(int)) if it does not already exist.
default IndexProbabilitySequence	ensureIndexProbabilitySequence(int initialCapacity)	Adds a new Index Probability Sequence (see IndexProbabilitySequence) if it does not already exist.
default IndexProbabilitySequence	getIndexProbabilitySequence()
default IndexProbabilitySequence	newIndexProbabilitySequence(int initialCapacity)	Adds a new Index Probability Sequence.
default void	removeIndexProbabilitySequence()	Removes the Index Probability Sequence (see IndexProbabilitySequence
static IndexProbabilitySequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Index Probability Sequence (see IndexProbabilitySequence)

Returns:

a wrapper object implementing the IndexProbabilitySequence.Holder interface.

builder

static IndexProbabilitySequence.Holder.Builder builder()

Returns:

a IndexProbabilitySequence.Holder.Builder to create Index Probability Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getIndexProbabilitySequence

default IndexProbabilitySequence getIndexProbabilitySequence()

Returns:

the Index Probability Sequence (see IndexProbabilitySequence)

newIndexProbabilitySequence

default IndexProbabilitySequence newIndexProbabilitySequence(int initialCapacity)

Adds a new Index Probability Sequence. (see IndexProbabilitySequence)

Parameters:

initialCapacity - the initial capacity for the new Index Probability Sequence

Returns:

the newly created IndexProbabilitySequence.

ensureIndexProbabilitySequence

default IndexProbabilitySequence ensureIndexProbabilitySequence(int initialCapacity)

Adds a new Index Probability Sequence (see IndexProbabilitySequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Index Probability Sequence (see IndexProbabilitySequence) or a new one with capacity initialCapacity.

ensureIndexProbabilitySequence

default IndexProbabilitySequence ensureIndexProbabilitySequence()

Adds a new Index Probability Sequence (see IndexProbabilitySequence) with initial capacity 1 (see ensureIndexProbabilitySequence(int)) if it does not already exist.

Returns:

either the already existing Index Probability Sequence (see IndexProbabilitySequence) or a new one with capacity 1.

containsIndexProbabilitySequence

default boolean containsIndexProbabilitySequence()

Returns:

whether it contains the Index Probability Sequence (see IndexProbabilitySequence)

removeIndexProbabilitySequence

default void removeIndexProbabilitySequence()

Removes the Index Probability Sequence (see IndexProbabilitySequence