Package org.dcm4che.typeddicom.dataelements

Interface OriginalImageSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

ImageBoxPixelPresentationModule

All Known Implementing Classes:

BasicImageBoxIOD, OriginalImageSequence.SimpleHolder

Enclosing class:

OriginalImageSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Original Image Sequence" (see OriginalImageSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OriginalImageSequence.Holder.Builder	builder()
static OriginalImageSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOriginalImageSequence()
default OriginalImageSequence	ensureOriginalImageSequence()	Adds a new Original Image Sequence (see OriginalImageSequence) with initial capacity 1 (see ensureOriginalImageSequence(int)) if it does not already exist.
default OriginalImageSequence	ensureOriginalImageSequence(int initialCapacity)	Adds a new Original Image Sequence (see OriginalImageSequence) if it does not already exist.
default OriginalImageSequence	getOriginalImageSequence()
default OriginalImageSequence	newOriginalImageSequence(int initialCapacity)	Adds a new Original Image Sequence.
default void	removeOriginalImageSequence()	Removes the Original Image Sequence (see OriginalImageSequence
static OriginalImageSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Original Image Sequence (see OriginalImageSequence)

Returns:

a wrapper object implementing the OriginalImageSequence.Holder interface.

builder

static OriginalImageSequence.Holder.Builder builder()

Returns:

a OriginalImageSequence.Holder.Builder to create Original Image Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getOriginalImageSequence

default OriginalImageSequence getOriginalImageSequence()

Returns:

the Original Image Sequence (see OriginalImageSequence)

newOriginalImageSequence

default OriginalImageSequence newOriginalImageSequence(int initialCapacity)

Adds a new Original Image Sequence. (see OriginalImageSequence)

Parameters:

initialCapacity - the initial capacity for the new Original Image Sequence

Returns:

the newly created OriginalImageSequence.

ensureOriginalImageSequence

default OriginalImageSequence ensureOriginalImageSequence(int initialCapacity)

Adds a new Original Image Sequence (see OriginalImageSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Original Image Sequence (see OriginalImageSequence) or a new one with capacity initialCapacity.

ensureOriginalImageSequence

default OriginalImageSequence ensureOriginalImageSequence()

Adds a new Original Image Sequence (see OriginalImageSequence) with initial capacity 1 (see ensureOriginalImageSequence(int)) if it does not already exist.

Returns:

either the already existing Original Image Sequence (see OriginalImageSequence) or a new one with capacity 1.

containsOriginalImageSequence

default boolean containsOriginalImageSequence()

Returns:

whether it contains the Original Image Sequence (see OriginalImageSequence)

removeOriginalImageSequence

default void removeOriginalImageSequence()

Removes the Original Image Sequence (see OriginalImageSequence