Package org.dcm4che.typeddicom.dataelements

Interface RecordedSourceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTBrachySessionRecordModule

All Known Implementing Classes:

RTBrachySessionRecordModule.SimpleWrapper, RTBrachyTreatmentRecordIOD

Enclosing class:

RecordedSourceSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Recorded Source Sequence" (see RecordedSourceSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RecordedSourceSequence.Holder.Builder	builder()
static RecordedSourceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRecordedSourceSequence()
default RecordedSourceSequence	ensureRecordedSourceSequence()	Adds a new Recorded Source Sequence (see RecordedSourceSequence) with initial capacity 1 (see ensureRecordedSourceSequence(int)) if it does not already exist.
default RecordedSourceSequence	ensureRecordedSourceSequence(int initialCapacity)	Adds a new Recorded Source Sequence (see RecordedSourceSequence) if it does not already exist.
default RecordedSourceSequence	getRecordedSourceSequence()
default RecordedSourceSequence	newRecordedSourceSequence(int initialCapacity)	Adds a new Recorded Source Sequence.
default void	removeRecordedSourceSequence()	Removes the Recorded Source Sequence (see RecordedSourceSequence
static RecordedSourceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Recorded Source Sequence (see RecordedSourceSequence)

Returns:

a wrapper object implementing the RecordedSourceSequence.Holder interface.

builder

static RecordedSourceSequence.Holder.Builder builder()

Returns:

a RecordedSourceSequence.Holder.Builder to create Recorded Source Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRecordedSourceSequence

default RecordedSourceSequence getRecordedSourceSequence()

Returns:

the Recorded Source Sequence (see RecordedSourceSequence)

newRecordedSourceSequence

default RecordedSourceSequence newRecordedSourceSequence(int initialCapacity)

Adds a new Recorded Source Sequence. (see RecordedSourceSequence)

Parameters:

initialCapacity - the initial capacity for the new Recorded Source Sequence

Returns:

the newly created RecordedSourceSequence.

ensureRecordedSourceSequence

default RecordedSourceSequence ensureRecordedSourceSequence(int initialCapacity)

Adds a new Recorded Source Sequence (see RecordedSourceSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Recorded Source Sequence (see RecordedSourceSequence) or a new one with capacity initialCapacity.

ensureRecordedSourceSequence

default RecordedSourceSequence ensureRecordedSourceSequence()

Adds a new Recorded Source Sequence (see RecordedSourceSequence) with initial capacity 1 (see ensureRecordedSourceSequence(int)) if it does not already exist.

Returns:

either the already existing Recorded Source Sequence (see RecordedSourceSequence) or a new one with capacity 1.

containsRecordedSourceSequence

default boolean containsRecordedSourceSequence()

Returns:

whether it contains the Recorded Source Sequence (see RecordedSourceSequence)

removeRecordedSourceSequence

default void removeRecordedSourceSequence()

Removes the Recorded Source Sequence (see RecordedSourceSequence