Package org.dcm4che.typeddicom.dataelements

Interface RTPrescriptionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTEnhancedPrescriptionModule

All Known Implementing Classes:

RTPhysicianIntentIOD, RTPrescriptionSequence.SimpleHolder

Enclosing class:

RTPrescriptionSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "RT Prescription Sequence" (see RTPrescriptionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTPrescriptionSequence.Holder.Builder	builder()
static RTPrescriptionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTPrescriptionSequence()
default RTPrescriptionSequence	ensureRTPrescriptionSequence()	Adds a new RT Prescription Sequence (see RTPrescriptionSequence) with initial capacity 1 (see ensureRTPrescriptionSequence(int)) if it does not already exist.
default RTPrescriptionSequence	ensureRTPrescriptionSequence(int initialCapacity)	Adds a new RT Prescription Sequence (see RTPrescriptionSequence) if it does not already exist.
default RTPrescriptionSequence	getRTPrescriptionSequence()
default RTPrescriptionSequence	newRTPrescriptionSequence(int initialCapacity)	Adds a new RT Prescription Sequence.
default void	removeRTPrescriptionSequence()	Removes the RT Prescription Sequence (see RTPrescriptionSequence
static RTPrescriptionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT Prescription Sequence (see RTPrescriptionSequence)

Returns:

a wrapper object implementing the RTPrescriptionSequence.Holder interface.

builder

static RTPrescriptionSequence.Holder.Builder builder()

Returns:

a RTPrescriptionSequence.Holder.Builder to create RT Prescription Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRTPrescriptionSequence

default RTPrescriptionSequence getRTPrescriptionSequence()

Returns:

the RT Prescription Sequence (see RTPrescriptionSequence)

newRTPrescriptionSequence

default RTPrescriptionSequence newRTPrescriptionSequence(int initialCapacity)

Adds a new RT Prescription Sequence. (see RTPrescriptionSequence)

Parameters:

initialCapacity - the initial capacity for the new RT Prescription Sequence

Returns:

the newly created RTPrescriptionSequence.

ensureRTPrescriptionSequence

default RTPrescriptionSequence ensureRTPrescriptionSequence(int initialCapacity)

Adds a new RT Prescription Sequence (see RTPrescriptionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing RT Prescription Sequence (see RTPrescriptionSequence) or a new one with capacity initialCapacity.

ensureRTPrescriptionSequence

default RTPrescriptionSequence ensureRTPrescriptionSequence()

Adds a new RT Prescription Sequence (see RTPrescriptionSequence) with initial capacity 1 (see ensureRTPrescriptionSequence(int)) if it does not already exist.

Returns:

either the already existing RT Prescription Sequence (see RTPrescriptionSequence) or a new one with capacity 1.

containsRTPrescriptionSequence

default boolean containsRTPrescriptionSequence()

Returns:

whether it contains the RT Prescription Sequence (see RTPrescriptionSequence)

removeRTPrescriptionSequence

default void removeRTPrescriptionSequence()

Removes the RT Prescription Sequence (see RTPrescriptionSequence