Package org.dcm4che.typeddicom.dataelements

Interface ReferencedRTInstanceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTRadiationRecordCommonModule

All Known Implementing Classes:

CArmPhotonElectronRadiationRecordIOD, RoboticArmRadiationRecordIOD, RTRadiationRecordCommonModule.SimpleWrapper, RTRadiationSalvageRecordIOD, TomotherapeuticRadiationRecordIOD

Enclosing class:

ReferencedRTInstanceSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced RT Instance Sequence" (see ReferencedRTInstanceSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedRTInstanceSequence.Holder.Builder	builder()
static ReferencedRTInstanceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedRTInstanceSequence()
default ReferencedRTInstanceSequence	ensureReferencedRTInstanceSequence()	Adds a new Referenced RT Instance Sequence (see ReferencedRTInstanceSequence) with initial capacity 1 (see ensureReferencedRTInstanceSequence(int)) if it does not already exist.
default ReferencedRTInstanceSequence	ensureReferencedRTInstanceSequence(int initialCapacity)	Adds a new Referenced RT Instance Sequence (see ReferencedRTInstanceSequence) if it does not already exist.
default ReferencedRTInstanceSequence	getReferencedRTInstanceSequence()
default ReferencedRTInstanceSequence	newReferencedRTInstanceSequence(int initialCapacity)	Adds a new Referenced RT Instance Sequence.
default void	removeReferencedRTInstanceSequence()	Removes the Referenced RT Instance Sequence (see ReferencedRTInstanceSequence
static ReferencedRTInstanceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced RT Instance Sequence (see ReferencedRTInstanceSequence)

Returns:

a wrapper object implementing the ReferencedRTInstanceSequence.Holder interface.

builder

static ReferencedRTInstanceSequence.Holder.Builder builder()

Returns:

a ReferencedRTInstanceSequence.Holder.Builder to create Referenced RT Instance Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ReferencedRTInstanceSequence.Holder.Builder to create Referenced RT Instance Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getReferencedRTInstanceSequence

default ReferencedRTInstanceSequence getReferencedRTInstanceSequence()

Returns:

the Referenced RT Instance Sequence (see ReferencedRTInstanceSequence)

newReferencedRTInstanceSequence

default ReferencedRTInstanceSequence newReferencedRTInstanceSequence(int initialCapacity)

Adds a new Referenced RT Instance Sequence. (see ReferencedRTInstanceSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced RT Instance Sequence

Returns:

the newly created ReferencedRTInstanceSequence.

ensureReferencedRTInstanceSequence

default ReferencedRTInstanceSequence ensureReferencedRTInstanceSequence(int initialCapacity)

Adds a new Referenced RT Instance Sequence (see ReferencedRTInstanceSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced RT Instance Sequence (see ReferencedRTInstanceSequence) or a new one with capacity initialCapacity.

ensureReferencedRTInstanceSequence

default ReferencedRTInstanceSequence ensureReferencedRTInstanceSequence()

Adds a new Referenced RT Instance Sequence (see ReferencedRTInstanceSequence) with initial capacity 1 (see ensureReferencedRTInstanceSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced RT Instance Sequence (see ReferencedRTInstanceSequence) or a new one with capacity 1.

containsReferencedRTInstanceSequence

default boolean containsReferencedRTInstanceSequence()

Returns:

whether it contains the Referenced RT Instance Sequence (see ReferencedRTInstanceSequence)

removeReferencedRTInstanceSequence

default void removeReferencedRTInstanceSequence()

Removes the Referenced RT Instance Sequence (see ReferencedRTInstanceSequence