Package org.dcm4che.typeddicom.dataelements

Interface RTReferencedStudySequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

ReferencedFrameOfReferenceSequence.Item

Enclosing class:

RTReferencedStudySequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTReferencedStudySequence.Holder.Builder	builder()
static RTReferencedStudySequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTReferencedStudySequence()
default RTReferencedStudySequence	ensureRTReferencedStudySequence()	Adds a new RT Referenced Study Sequence (see RTReferencedStudySequence) with initial capacity 1 (see ensureRTReferencedStudySequence(int)) if it does not already exist.
default RTReferencedStudySequence	ensureRTReferencedStudySequence(int initialCapacity)	Adds a new RT Referenced Study Sequence (see RTReferencedStudySequence) if it does not already exist.
default RTReferencedStudySequence	getRTReferencedStudySequence()
default RTReferencedStudySequence	newRTReferencedStudySequence(int initialCapacity)	Adds a new RT Referenced Study Sequence.
default void	removeRTReferencedStudySequence()	Removes the RT Referenced Study Sequence (see RTReferencedStudySequence
static RTReferencedStudySequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT Referenced Study Sequence (see RTReferencedStudySequence)

Returns:

a wrapper object implementing the RTReferencedStudySequence.Holder interface.

builder

static RTReferencedStudySequence.Holder.Builder builder()

Returns:

a RTReferencedStudySequence.Holder.Builder to create RT Referenced Study Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRTReferencedStudySequence

default RTReferencedStudySequence getRTReferencedStudySequence()

Returns:

the RT Referenced Study Sequence (see RTReferencedStudySequence)

newRTReferencedStudySequence

default RTReferencedStudySequence newRTReferencedStudySequence(int initialCapacity)

Adds a new RT Referenced Study Sequence. (see RTReferencedStudySequence)

Parameters:

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

Returns:

the newly created RTReferencedStudySequence.

ensureRTReferencedStudySequence

default RTReferencedStudySequence ensureRTReferencedStudySequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureRTReferencedStudySequence

default RTReferencedStudySequence ensureRTReferencedStudySequence()

Adds a new RT Referenced Study Sequence (see RTReferencedStudySequence) with initial capacity 1 (see ensureRTReferencedStudySequence(int)) if it does not already exist.

Returns:

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

containsRTReferencedStudySequence

default boolean containsRTReferencedStudySequence()

Returns:

whether it contains the RT Referenced Study Sequence (see RTReferencedStudySequence)

removeRTReferencedStudySequence

default void removeRTReferencedStudySequence()

Removes the RT Referenced Study Sequence (see RTReferencedStudySequence