Package org.dcm4che.typeddicom.dataelements

Interface SegmentSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

SegmentationImageModule, SurfaceSegmentationModule

All Known Implementing Classes:

SegmentationImageModule.SimpleWrapper, SegmentationIOD, SurfaceSegmentationIOD, SurfaceSegmentationModule.SimpleWrapper

Enclosing class:

SegmentSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Segment Sequence" (see SegmentSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SegmentSequence.Holder.Builder	builder()
static SegmentSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSegmentSequence()
default SegmentSequence	ensureSegmentSequence()	Adds a new Segment Sequence (see SegmentSequence) with initial capacity 1 (see ensureSegmentSequence(int)) if it does not already exist.
default SegmentSequence	ensureSegmentSequence(int initialCapacity)	Adds a new Segment Sequence (see SegmentSequence) if it does not already exist.
default SegmentSequence	getSegmentSequence()
default SegmentSequence	newSegmentSequence(int initialCapacity)	Adds a new Segment Sequence.
default void	removeSegmentSequence()	Removes the Segment Sequence (see SegmentSequence
static SegmentSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Segment Sequence (see SegmentSequence)

Returns:

a wrapper object implementing the SegmentSequence.Holder interface.

builder

static SegmentSequence.Holder.Builder builder()

Returns:

a SegmentSequence.Holder.Builder to create Segment Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getSegmentSequence

default SegmentSequence getSegmentSequence()

Returns:

the Segment Sequence (see SegmentSequence)

newSegmentSequence

default SegmentSequence newSegmentSequence(int initialCapacity)

Adds a new Segment Sequence. (see SegmentSequence)

Parameters:

initialCapacity - the initial capacity for the new Segment Sequence

Returns:

the newly created SegmentSequence.

ensureSegmentSequence

default SegmentSequence ensureSegmentSequence(int initialCapacity)

Adds a new Segment Sequence (see SegmentSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Segment Sequence (see SegmentSequence) or a new one with capacity initialCapacity.

ensureSegmentSequence

default SegmentSequence ensureSegmentSequence()

Adds a new Segment Sequence (see SegmentSequence) with initial capacity 1 (see ensureSegmentSequence(int)) if it does not already exist.

Returns:

either the already existing Segment Sequence (see SegmentSequence) or a new one with capacity 1.

containsSegmentSequence

default boolean containsSegmentSequence()

Returns:

whether it contains the Segment Sequence (see SegmentSequence)

removeSegmentSequence

default void removeSegmentSequence()

Removes the Segment Sequence (see SegmentSequence