Package org.dcm4che.typeddicom.dataelements

Interface RTSegmentAnnotationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTSegmentAnnotationModule

All Known Implementing Classes:

RTSegmentAnnotationIOD, RTSegmentAnnotationModule.SimpleWrapper

Enclosing class:

RTSegmentAnnotationSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTSegmentAnnotationSequence.Holder.Builder	builder()
static RTSegmentAnnotationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTSegmentAnnotationSequence()
default RTSegmentAnnotationSequence	ensureRTSegmentAnnotationSequence()	Adds a new RT Segment Annotation Sequence (see RTSegmentAnnotationSequence) with initial capacity 1 (see ensureRTSegmentAnnotationSequence(int)) if it does not already exist.
default RTSegmentAnnotationSequence	ensureRTSegmentAnnotationSequence(int initialCapacity)	Adds a new RT Segment Annotation Sequence (see RTSegmentAnnotationSequence) if it does not already exist.
default RTSegmentAnnotationSequence	getRTSegmentAnnotationSequence()
default RTSegmentAnnotationSequence	newRTSegmentAnnotationSequence(int initialCapacity)	Adds a new RT Segment Annotation Sequence.
default void	removeRTSegmentAnnotationSequence()	Removes the RT Segment Annotation Sequence (see RTSegmentAnnotationSequence
static RTSegmentAnnotationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT Segment Annotation Sequence (see RTSegmentAnnotationSequence)

Returns:

a wrapper object implementing the RTSegmentAnnotationSequence.Holder interface.

builder

static RTSegmentAnnotationSequence.Holder.Builder builder()

Returns:

a RTSegmentAnnotationSequence.Holder.Builder to create RT Segment Annotation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRTSegmentAnnotationSequence

default RTSegmentAnnotationSequence getRTSegmentAnnotationSequence()

Returns:

the RT Segment Annotation Sequence (see RTSegmentAnnotationSequence)

newRTSegmentAnnotationSequence

default RTSegmentAnnotationSequence newRTSegmentAnnotationSequence(int initialCapacity)

Adds a new RT Segment Annotation Sequence. (see RTSegmentAnnotationSequence)

Parameters:

initialCapacity - the initial capacity for the new RT Segment Annotation Sequence

Returns:

the newly created RTSegmentAnnotationSequence.

ensureRTSegmentAnnotationSequence

default RTSegmentAnnotationSequence ensureRTSegmentAnnotationSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureRTSegmentAnnotationSequence

default RTSegmentAnnotationSequence ensureRTSegmentAnnotationSequence()

Adds a new RT Segment Annotation Sequence (see RTSegmentAnnotationSequence) with initial capacity 1 (see ensureRTSegmentAnnotationSequence(int)) if it does not already exist.

Returns:

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

containsRTSegmentAnnotationSequence

default boolean containsRTSegmentAnnotationSequence()

Returns:

whether it contains the RT Segment Annotation Sequence (see RTSegmentAnnotationSequence)

removeRTSegmentAnnotationSequence

default void removeRTSegmentAnnotationSequence()

Removes the RT Segment Annotation Sequence (see RTSegmentAnnotationSequence