Package org.dcm4che.typeddicom.dataelements

Interface StageCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

EnhancedUSImageModule, USImageModule

All Known Implementing Classes:

EnhancedUSImageModule.SimpleWrapper, EnhancedUSVolumeIOD, USImageIOD, USImageModule.SimpleWrapper, USMultiFrameImageIOD

Enclosing class:

StageCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Stage Code Sequence" (see StageCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StageCodeSequence.Holder.Builder	builder()
static StageCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsStageCodeSequence()
default StageCodeSequence	ensureStageCodeSequence()	Adds a new Stage Code Sequence (see StageCodeSequence) with initial capacity 1 (see ensureStageCodeSequence(int)) if it does not already exist.
default StageCodeSequence	ensureStageCodeSequence(int initialCapacity)	Adds a new Stage Code Sequence (see StageCodeSequence) if it does not already exist.
default StageCodeSequence	getStageCodeSequence()
default StageCodeSequence	newStageCodeSequence(int initialCapacity)	Adds a new Stage Code Sequence.
default void	removeStageCodeSequence()	Removes the Stage Code Sequence (see StageCodeSequence
static StageCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Stage Code Sequence (see StageCodeSequence)

Returns:

a wrapper object implementing the StageCodeSequence.Holder interface.

builder

static StageCodeSequence.Holder.Builder builder()

Returns:

a StageCodeSequence.Holder.Builder to create Stage Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getStageCodeSequence

default StageCodeSequence getStageCodeSequence()

Returns:

the Stage Code Sequence (see StageCodeSequence)

newStageCodeSequence

default StageCodeSequence newStageCodeSequence(int initialCapacity)

Adds a new Stage Code Sequence. (see StageCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Stage Code Sequence

Returns:

the newly created StageCodeSequence.

ensureStageCodeSequence

default StageCodeSequence ensureStageCodeSequence(int initialCapacity)

Adds a new Stage Code Sequence (see StageCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Stage Code Sequence (see StageCodeSequence) or a new one with capacity initialCapacity.

ensureStageCodeSequence

default StageCodeSequence ensureStageCodeSequence()

Adds a new Stage Code Sequence (see StageCodeSequence) with initial capacity 1 (see ensureStageCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Stage Code Sequence (see StageCodeSequence) or a new one with capacity 1.

containsStageCodeSequence

default boolean containsStageCodeSequence()

Returns:

whether it contains the Stage Code Sequence (see StageCodeSequence)

removeStageCodeSequence

default void removeStageCodeSequence()

Removes the Stage Code Sequence (see StageCodeSequence