Package org.dcm4che.typeddicom.dataelements

Interface PriorTreatmentReferenceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

PriorTreatmentReferenceSequence.SimpleHolder, RTPrescriptionSequence.Item

Enclosing class:

PriorTreatmentReferenceSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Prior Treatment Reference Sequence" (see PriorTreatmentReferenceSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PriorTreatmentReferenceSequence.Holder.Builder	builder()
static PriorTreatmentReferenceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPriorTreatmentReferenceSequence()
default PriorTreatmentReferenceSequence	ensurePriorTreatmentReferenceSequence()	Adds a new Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence) with initial capacity 1 (see ensurePriorTreatmentReferenceSequence(int)) if it does not already exist.
default PriorTreatmentReferenceSequence	ensurePriorTreatmentReferenceSequence(int initialCapacity)	Adds a new Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence) if it does not already exist.
default PriorTreatmentReferenceSequence	getPriorTreatmentReferenceSequence()
default PriorTreatmentReferenceSequence	newPriorTreatmentReferenceSequence(int initialCapacity)	Adds a new Prior Treatment Reference Sequence.
default void	removePriorTreatmentReferenceSequence()	Removes the Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence
static PriorTreatmentReferenceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence)

Returns:

a wrapper object implementing the PriorTreatmentReferenceSequence.Holder interface.

builder

static PriorTreatmentReferenceSequence.Holder.Builder builder()

Returns:

a PriorTreatmentReferenceSequence.Holder.Builder to create Prior Treatment Reference Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPriorTreatmentReferenceSequence

default PriorTreatmentReferenceSequence getPriorTreatmentReferenceSequence()

Returns:

the Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence)

newPriorTreatmentReferenceSequence

default PriorTreatmentReferenceSequence newPriorTreatmentReferenceSequence(int initialCapacity)

Adds a new Prior Treatment Reference Sequence. (see PriorTreatmentReferenceSequence)

Parameters:

initialCapacity - the initial capacity for the new Prior Treatment Reference Sequence

Returns:

the newly created PriorTreatmentReferenceSequence.

ensurePriorTreatmentReferenceSequence

default PriorTreatmentReferenceSequence ensurePriorTreatmentReferenceSequence(int initialCapacity)

Adds a new Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence) or a new one with capacity initialCapacity.

ensurePriorTreatmentReferenceSequence

default PriorTreatmentReferenceSequence ensurePriorTreatmentReferenceSequence()

Adds a new Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence) with initial capacity 1 (see ensurePriorTreatmentReferenceSequence(int)) if it does not already exist.

Returns:

either the already existing Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence) or a new one with capacity 1.

containsPriorTreatmentReferenceSequence

default boolean containsPriorTreatmentReferenceSequence()

Returns:

whether it contains the Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence)

removePriorTreatmentReferenceSequence

default void removePriorTreatmentReferenceSequence()

Removes the Prior Treatment Reference Sequence (see PriorTreatmentReferenceSequence