Package org.dcm4che.typeddicom.dataelements

Interface MatrixSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

MatrixRegistrationSequence.Item, MatrixSequence.SimpleHolder

Enclosing class:

MatrixSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MatrixSequence.Holder.Builder	builder()
static MatrixSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsMatrixSequence()
default MatrixSequence	ensureMatrixSequence()	Adds a new Matrix Sequence (see MatrixSequence) with initial capacity 1 (see ensureMatrixSequence(int)) if it does not already exist.
default MatrixSequence	ensureMatrixSequence(int initialCapacity)	Adds a new Matrix Sequence (see MatrixSequence) if it does not already exist.
default MatrixSequence	getMatrixSequence()
default MatrixSequence	newMatrixSequence(int initialCapacity)	Adds a new Matrix Sequence.
default void	removeMatrixSequence()	Removes the Matrix Sequence (see MatrixSequence
static MatrixSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Matrix Sequence (see MatrixSequence)

Returns:

a wrapper object implementing the MatrixSequence.Holder interface.

builder

static MatrixSequence.Holder.Builder builder()

Returns:

a MatrixSequence.Holder.Builder to create Matrix Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getMatrixSequence

default MatrixSequence getMatrixSequence()

Returns:

the Matrix Sequence (see MatrixSequence)

newMatrixSequence

default MatrixSequence newMatrixSequence(int initialCapacity)

Adds a new Matrix Sequence. (see MatrixSequence)

Parameters:

initialCapacity - the initial capacity for the new Matrix Sequence

Returns:

the newly created MatrixSequence.

ensureMatrixSequence

default MatrixSequence ensureMatrixSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureMatrixSequence

default MatrixSequence ensureMatrixSequence()

Adds a new Matrix Sequence (see MatrixSequence) with initial capacity 1 (see ensureMatrixSequence(int)) if it does not already exist.

Returns:

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

containsMatrixSequence

default boolean containsMatrixSequence()

Returns:

whether it contains the Matrix Sequence (see MatrixSequence)

removeMatrixSequence

default void removeMatrixSequence()

Removes the Matrix Sequence (see MatrixSequence