Package org.dcm4che.typeddicom.dataelements

Interface PrismSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

LeftLensSequence.Item, RightLensSequence.Item, SubjectiveRefractionLeftEyeSequence.Item, SubjectiveRefractionRightEyeSequence.Item, UnspecifiedLateralityLensSequence.Item

Enclosing class:

PrismSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PrismSequence.Holder.Builder	builder()
static PrismSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPrismSequence()
default PrismSequence	ensurePrismSequence()	Adds a new Prism Sequence (see PrismSequence) with initial capacity 1 (see ensurePrismSequence(int)) if it does not already exist.
default PrismSequence	ensurePrismSequence(int initialCapacity)	Adds a new Prism Sequence (see PrismSequence) if it does not already exist.
default PrismSequence	getPrismSequence()
default PrismSequence	newPrismSequence(int initialCapacity)	Adds a new Prism Sequence.
default void	removePrismSequence()	Removes the Prism Sequence (see PrismSequence
static PrismSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Prism Sequence (see PrismSequence)

Returns:

a wrapper object implementing the PrismSequence.Holder interface.

builder

static PrismSequence.Holder.Builder builder()

Returns:

a PrismSequence.Holder.Builder to create Prism Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPrismSequence

default PrismSequence getPrismSequence()

Returns:

the Prism Sequence (see PrismSequence)

newPrismSequence

default PrismSequence newPrismSequence(int initialCapacity)

Adds a new Prism Sequence. (see PrismSequence)

Parameters:

initialCapacity - the initial capacity for the new Prism Sequence

Returns:

the newly created PrismSequence.

ensurePrismSequence

default PrismSequence ensurePrismSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensurePrismSequence

default PrismSequence ensurePrismSequence()

Adds a new Prism Sequence (see PrismSequence) with initial capacity 1 (see ensurePrismSequence(int)) if it does not already exist.

Returns:

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

containsPrismSequence

default boolean containsPrismSequence()

Returns:

whether it contains the Prism Sequence (see PrismSequence)

removePrismSequence

default void removePrismSequence()

Removes the Prism Sequence (see PrismSequence