Package org.dcm4che.typeddicom.dataelements

Interface FieldOfViewSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

FieldOfViewSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Field of View Sequence" (see FieldOfViewSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FieldOfViewSequence.Holder.Builder	builder()
static FieldOfViewSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFieldOfViewSequence()
default FieldOfViewSequence	ensureFieldOfViewSequence()	Adds a new Field of View Sequence (see FieldOfViewSequence) with initial capacity 1 (see ensureFieldOfViewSequence(int)) if it does not already exist.
default FieldOfViewSequence	ensureFieldOfViewSequence(int initialCapacity)	Adds a new Field of View Sequence (see FieldOfViewSequence) if it does not already exist.
default FieldOfViewSequence	getFieldOfViewSequence()
default FieldOfViewSequence	newFieldOfViewSequence(int initialCapacity)	Adds a new Field of View Sequence.
default void	removeFieldOfViewSequence()	Removes the Field of View Sequence (see FieldOfViewSequence
static FieldOfViewSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Field of View Sequence (see FieldOfViewSequence)

Returns:

a wrapper object implementing the FieldOfViewSequence.Holder interface.

builder

static FieldOfViewSequence.Holder.Builder builder()

Returns:

a FieldOfViewSequence.Holder.Builder to create Field of View Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFieldOfViewSequence

default FieldOfViewSequence getFieldOfViewSequence()

Returns:

the Field of View Sequence (see FieldOfViewSequence)

newFieldOfViewSequence

default FieldOfViewSequence newFieldOfViewSequence(int initialCapacity)

Adds a new Field of View Sequence. (see FieldOfViewSequence)

Parameters:

initialCapacity - the initial capacity for the new Field of View Sequence

Returns:

the newly created FieldOfViewSequence.

ensureFieldOfViewSequence

default FieldOfViewSequence ensureFieldOfViewSequence(int initialCapacity)

Adds a new Field of View Sequence (see FieldOfViewSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Field of View Sequence (see FieldOfViewSequence) or a new one with capacity initialCapacity.

ensureFieldOfViewSequence

default FieldOfViewSequence ensureFieldOfViewSequence()

Adds a new Field of View Sequence (see FieldOfViewSequence) with initial capacity 1 (see ensureFieldOfViewSequence(int)) if it does not already exist.

Returns:

either the already existing Field of View Sequence (see FieldOfViewSequence) or a new one with capacity 1.

containsFieldOfViewSequence

default boolean containsFieldOfViewSequence()

Returns:

whether it contains the Field of View Sequence (see FieldOfViewSequence)

removeFieldOfViewSequence

default void removeFieldOfViewSequence()

Removes the Field of View Sequence (see FieldOfViewSequence