Package org.dcm4che.typeddicom.dataelements

Interface ReferencedImageNavigationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

ReferencedImageNavigationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Image Navigation Sequence" (see ReferencedImageNavigationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedImageNavigationSequence.Holder.Builder	builder()
static ReferencedImageNavigationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedImageNavigationSequence()
default ReferencedImageNavigationSequence	ensureReferencedImageNavigationSequence()	Adds a new Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence) with initial capacity 1 (see ensureReferencedImageNavigationSequence(int)) if it does not already exist.
default ReferencedImageNavigationSequence	ensureReferencedImageNavigationSequence(int initialCapacity)	Adds a new Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence) if it does not already exist.
default ReferencedImageNavigationSequence	getReferencedImageNavigationSequence()
default ReferencedImageNavigationSequence	newReferencedImageNavigationSequence(int initialCapacity)	Adds a new Referenced Image Navigation Sequence.
default void	removeReferencedImageNavigationSequence()	Removes the Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence
static ReferencedImageNavigationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence)

Returns:

a wrapper object implementing the ReferencedImageNavigationSequence.Holder interface.

builder

static ReferencedImageNavigationSequence.Holder.Builder builder()

Returns:

a ReferencedImageNavigationSequence.Holder.Builder to create Referenced Image Navigation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ReferencedImageNavigationSequence.Holder.Builder to create Referenced Image Navigation Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getReferencedImageNavigationSequence

default ReferencedImageNavigationSequence getReferencedImageNavigationSequence()

Returns:

the Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence)

newReferencedImageNavigationSequence

default ReferencedImageNavigationSequence newReferencedImageNavigationSequence(int initialCapacity)

Adds a new Referenced Image Navigation Sequence. (see ReferencedImageNavigationSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Image Navigation Sequence

Returns:

the newly created ReferencedImageNavigationSequence.

ensureReferencedImageNavigationSequence

default ReferencedImageNavigationSequence ensureReferencedImageNavigationSequence(int initialCapacity)

Adds a new Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence) or a new one with capacity initialCapacity.

ensureReferencedImageNavigationSequence

default ReferencedImageNavigationSequence ensureReferencedImageNavigationSequence()

Adds a new Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence) with initial capacity 1 (see ensureReferencedImageNavigationSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence) or a new one with capacity 1.

containsReferencedImageNavigationSequence

default boolean containsReferencedImageNavigationSequence()

Returns:

whether it contains the Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence)

removeReferencedImageNavigationSequence

default void removeReferencedImageNavigationSequence()

Removes the Referenced Image Navigation Sequence (see ReferencedImageNavigationSequence