Package org.dcm4che.typeddicom.dataelements

Interface SegmentReferenceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

SegmentReferenceModule

All Known Implementing Classes:

RTSegmentAnnotationIOD, SegmentReferenceModule.SimpleWrapper

Enclosing class:

SegmentReferenceSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SegmentReferenceSequence.Holder.Builder	builder()
static SegmentReferenceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSegmentReferenceSequence()
default SegmentReferenceSequence	ensureSegmentReferenceSequence()	Adds a new Segment Reference Sequence (see SegmentReferenceSequence) with initial capacity 1 (see ensureSegmentReferenceSequence(int)) if it does not already exist.
default SegmentReferenceSequence	ensureSegmentReferenceSequence(int initialCapacity)	Adds a new Segment Reference Sequence (see SegmentReferenceSequence) if it does not already exist.
default SegmentReferenceSequence	getSegmentReferenceSequence()
default SegmentReferenceSequence	newSegmentReferenceSequence(int initialCapacity)	Adds a new Segment Reference Sequence.
default void	removeSegmentReferenceSequence()	Removes the Segment Reference Sequence (see SegmentReferenceSequence
static SegmentReferenceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Segment Reference Sequence (see SegmentReferenceSequence)

Returns:

a wrapper object implementing the SegmentReferenceSequence.Holder interface.

builder

static SegmentReferenceSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getSegmentReferenceSequence

default SegmentReferenceSequence getSegmentReferenceSequence()

Returns:

the Segment Reference Sequence (see SegmentReferenceSequence)

newSegmentReferenceSequence

default SegmentReferenceSequence newSegmentReferenceSequence(int initialCapacity)

Adds a new Segment Reference Sequence. (see SegmentReferenceSequence)

Parameters:

initialCapacity - the initial capacity for the new Segment Reference Sequence

Returns:

the newly created SegmentReferenceSequence.

ensureSegmentReferenceSequence

default SegmentReferenceSequence ensureSegmentReferenceSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureSegmentReferenceSequence

default SegmentReferenceSequence ensureSegmentReferenceSequence()

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

Returns:

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

containsSegmentReferenceSequence

default boolean containsSegmentReferenceSequence()

Returns:

whether it contains the Segment Reference Sequence (see SegmentReferenceSequence)

removeSegmentReferenceSequence

default void removeSegmentReferenceSequence()

Removes the Segment Reference Sequence (see SegmentReferenceSequence