Package org.dcm4che.typeddicom.dataelements

Interface RegistrationSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

SpatialRegistrationModule

All Known Implementing Classes:

RegistrationSequence.SimpleHolder, SpatialRegistrationIOD

Enclosing class:

RegistrationSequence

public static interface RegistrationSequence.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RegistrationSequence.Holder.Builder	builder()
static RegistrationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRegistrationSequence()
default RegistrationSequence	ensureRegistrationSequence()	Adds a new Registration Sequence (see RegistrationSequence) with initial capacity 1 (see ensureRegistrationSequence(int)) if it does not already exist.
default RegistrationSequence	ensureRegistrationSequence(int initialCapacity)	Adds a new Registration Sequence (see RegistrationSequence) if it does not already exist.
default RegistrationSequence	getRegistrationSequence()
default RegistrationSequence	newRegistrationSequence(int initialCapacity)	Adds a new Registration Sequence.
default void	removeRegistrationSequence()	Removes the Registration Sequence (see RegistrationSequence
static RegistrationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Registration Sequence (see RegistrationSequence)

Returns:

A wrapper object implementing the RegistrationSequence.Holder interface.

builder

static RegistrationSequence.Holder.Builder builder()

Returns:

a RegistrationSequence.Holder.Builder to create Registration Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRegistrationSequence

default RegistrationSequence getRegistrationSequence()

Returns:

the Registration Sequence (see RegistrationSequence)

newRegistrationSequence

default RegistrationSequence newRegistrationSequence(int initialCapacity)

Adds a new Registration Sequence. (see RegistrationSequence)

Parameters:

initialCapacity - the initial capacity for the new Registration Sequence

ensureRegistrationSequence

default RegistrationSequence ensureRegistrationSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureRegistrationSequence

default RegistrationSequence ensureRegistrationSequence()

Adds a new Registration Sequence (see RegistrationSequence) with initial capacity 1 (see ensureRegistrationSequence(int)) if it does not already exist.

Returns:

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

containsRegistrationSequence

default boolean containsRegistrationSequence()

Returns:

Whether it contains the Registration Sequence (see RegistrationSequence)

removeRegistrationSequence

default void removeRegistrationSequence()

Removes the Registration Sequence (see RegistrationSequence