Package org.dcm4che.typeddicom.dataelements

Interface AnnotationGroupSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MicroscopyBulkSimpleAnnotationsModule

All Known Implementing Classes:

MicroscopyBulkSimpleAnnotationsIOD, MicroscopyBulkSimpleAnnotationsModule.SimpleWrapper

Enclosing class:

AnnotationGroupSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Annotation Group Sequence" (see AnnotationGroupSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AnnotationGroupSequence.Holder.Builder	builder()
static AnnotationGroupSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsAnnotationGroupSequence()
default AnnotationGroupSequence	ensureAnnotationGroupSequence()	Adds a new Annotation Group Sequence (see AnnotationGroupSequence) with initial capacity 1 (see ensureAnnotationGroupSequence(int)) if it does not already exist.
default AnnotationGroupSequence	ensureAnnotationGroupSequence(int initialCapacity)	Adds a new Annotation Group Sequence (see AnnotationGroupSequence) if it does not already exist.
default AnnotationGroupSequence	getAnnotationGroupSequence()
default AnnotationGroupSequence	newAnnotationGroupSequence(int initialCapacity)	Adds a new Annotation Group Sequence.
default void	removeAnnotationGroupSequence()	Removes the Annotation Group Sequence (see AnnotationGroupSequence
static AnnotationGroupSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Annotation Group Sequence (see AnnotationGroupSequence)

Returns:

a wrapper object implementing the AnnotationGroupSequence.Holder interface.

builder

static AnnotationGroupSequence.Holder.Builder builder()

Returns:

a AnnotationGroupSequence.Holder.Builder to create Annotation Group Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getAnnotationGroupSequence

default AnnotationGroupSequence getAnnotationGroupSequence()

Returns:

the Annotation Group Sequence (see AnnotationGroupSequence)

newAnnotationGroupSequence

default AnnotationGroupSequence newAnnotationGroupSequence(int initialCapacity)

Adds a new Annotation Group Sequence. (see AnnotationGroupSequence)

Parameters:

initialCapacity - the initial capacity for the new Annotation Group Sequence

Returns:

the newly created AnnotationGroupSequence.

ensureAnnotationGroupSequence

default AnnotationGroupSequence ensureAnnotationGroupSequence(int initialCapacity)

Adds a new Annotation Group Sequence (see AnnotationGroupSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Annotation Group Sequence (see AnnotationGroupSequence) or a new one with capacity initialCapacity.

ensureAnnotationGroupSequence

default AnnotationGroupSequence ensureAnnotationGroupSequence()

Adds a new Annotation Group Sequence (see AnnotationGroupSequence) with initial capacity 1 (see ensureAnnotationGroupSequence(int)) if it does not already exist.

Returns:

either the already existing Annotation Group Sequence (see AnnotationGroupSequence) or a new one with capacity 1.

containsAnnotationGroupSequence

default boolean containsAnnotationGroupSequence()

Returns:

whether it contains the Annotation Group Sequence (see AnnotationGroupSequence)

removeAnnotationGroupSequence

default void removeAnnotationGroupSequence()

Removes the Annotation Group Sequence (see AnnotationGroupSequence