Package org.dcm4che.typeddicom.dataelements

Interface NavigationIndicatorSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

HangingProtocolDisplayModule

All Known Implementing Classes:

HangingProtocolDisplayModule.SimpleWrapper, HangingProtocolIOD

Enclosing class:

NavigationIndicatorSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Navigation Indicator Sequence" (see NavigationIndicatorSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NavigationIndicatorSequence.Holder.Builder	builder()
static NavigationIndicatorSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsNavigationIndicatorSequence()
default NavigationIndicatorSequence	ensureNavigationIndicatorSequence()	Adds a new Navigation Indicator Sequence (see NavigationIndicatorSequence) with initial capacity 1 (see ensureNavigationIndicatorSequence(int)) if it does not already exist.
default NavigationIndicatorSequence	ensureNavigationIndicatorSequence(int initialCapacity)	Adds a new Navigation Indicator Sequence (see NavigationIndicatorSequence) if it does not already exist.
default NavigationIndicatorSequence	getNavigationIndicatorSequence()
default NavigationIndicatorSequence	newNavigationIndicatorSequence(int initialCapacity)	Adds a new Navigation Indicator Sequence.
default void	removeNavigationIndicatorSequence()	Removes the Navigation Indicator Sequence (see NavigationIndicatorSequence
static NavigationIndicatorSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Navigation Indicator Sequence (see NavigationIndicatorSequence)

Returns:

a wrapper object implementing the NavigationIndicatorSequence.Holder interface.

builder

static NavigationIndicatorSequence.Holder.Builder builder()

Returns:

a NavigationIndicatorSequence.Holder.Builder to create Navigation Indicator Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getNavigationIndicatorSequence

default NavigationIndicatorSequence getNavigationIndicatorSequence()

Returns:

the Navigation Indicator Sequence (see NavigationIndicatorSequence)

newNavigationIndicatorSequence

default NavigationIndicatorSequence newNavigationIndicatorSequence(int initialCapacity)

Adds a new Navigation Indicator Sequence. (see NavigationIndicatorSequence)

Parameters:

initialCapacity - the initial capacity for the new Navigation Indicator Sequence

Returns:

the newly created NavigationIndicatorSequence.

ensureNavigationIndicatorSequence

default NavigationIndicatorSequence ensureNavigationIndicatorSequence(int initialCapacity)

Adds a new Navigation Indicator Sequence (see NavigationIndicatorSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Navigation Indicator Sequence (see NavigationIndicatorSequence) or a new one with capacity initialCapacity.

ensureNavigationIndicatorSequence

default NavigationIndicatorSequence ensureNavigationIndicatorSequence()

Adds a new Navigation Indicator Sequence (see NavigationIndicatorSequence) with initial capacity 1 (see ensureNavigationIndicatorSequence(int)) if it does not already exist.

Returns:

either the already existing Navigation Indicator Sequence (see NavigationIndicatorSequence) or a new one with capacity 1.

containsNavigationIndicatorSequence

default boolean containsNavigationIndicatorSequence()

Returns:

whether it contains the Navigation Indicator Sequence (see NavigationIndicatorSequence)

removeNavigationIndicatorSequence

default void removeNavigationIndicatorSequence()

Removes the Navigation Indicator Sequence (see NavigationIndicatorSequence