Package org.dcm4che.typeddicom.dataelements

Interface FrameAnatomySequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

CurrentFrameFunctionalGroupsSequence.Item, FrameAnatomySequence.SimpleHolder, PerFrameFunctionalGroupsSequence.Item, SharedFunctionalGroupsSequence.Item

Enclosing class:

FrameAnatomySequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Frame Anatomy Sequence" (see FrameAnatomySequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FrameAnatomySequence.Holder.Builder	builder()
static FrameAnatomySequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFrameAnatomySequence()
default FrameAnatomySequence	ensureFrameAnatomySequence()	Adds a new Frame Anatomy Sequence (see FrameAnatomySequence) with initial capacity 1 (see ensureFrameAnatomySequence(int)) if it does not already exist.
default FrameAnatomySequence	ensureFrameAnatomySequence(int initialCapacity)	Adds a new Frame Anatomy Sequence (see FrameAnatomySequence) if it does not already exist.
default FrameAnatomySequence	getFrameAnatomySequence()
default FrameAnatomySequence	newFrameAnatomySequence(int initialCapacity)	Adds a new Frame Anatomy Sequence.
default void	removeFrameAnatomySequence()	Removes the Frame Anatomy Sequence (see FrameAnatomySequence
static FrameAnatomySequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Frame Anatomy Sequence (see FrameAnatomySequence)

Returns:

a wrapper object implementing the FrameAnatomySequence.Holder interface.

builder

static FrameAnatomySequence.Holder.Builder builder()

Returns:

a FrameAnatomySequence.Holder.Builder to create Frame Anatomy Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFrameAnatomySequence

default FrameAnatomySequence getFrameAnatomySequence()

Returns:

the Frame Anatomy Sequence (see FrameAnatomySequence)

newFrameAnatomySequence

default FrameAnatomySequence newFrameAnatomySequence(int initialCapacity)

Adds a new Frame Anatomy Sequence. (see FrameAnatomySequence)

Parameters:

initialCapacity - the initial capacity for the new Frame Anatomy Sequence

Returns:

the newly created FrameAnatomySequence.

ensureFrameAnatomySequence

default FrameAnatomySequence ensureFrameAnatomySequence(int initialCapacity)

Adds a new Frame Anatomy Sequence (see FrameAnatomySequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Frame Anatomy Sequence (see FrameAnatomySequence) or a new one with capacity initialCapacity.

ensureFrameAnatomySequence

default FrameAnatomySequence ensureFrameAnatomySequence()

Adds a new Frame Anatomy Sequence (see FrameAnatomySequence) with initial capacity 1 (see ensureFrameAnatomySequence(int)) if it does not already exist.

Returns:

either the already existing Frame Anatomy Sequence (see FrameAnatomySequence) or a new one with capacity 1.

containsFrameAnatomySequence

default boolean containsFrameAnatomySequence()

Returns:

whether it contains the Frame Anatomy Sequence (see FrameAnatomySequence)

removeFrameAnatomySequence

default void removeFrameAnatomySequence()

Removes the Frame Anatomy Sequence (see FrameAnatomySequence