Package org.dcm4che.typeddicom.dataelements

Interface SubstanceAdministrationParameterSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

SubstanceAdministrationLogModule

All Known Implementing Classes:

SubstanceAdministrationParameterSequence.SimpleHolder

Enclosing class:

SubstanceAdministrationParameterSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Substance Administration Parameter Sequence" (see SubstanceAdministrationParameterSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SubstanceAdministrationParameterSequence.Holder.Builder	builder()
static SubstanceAdministrationParameterSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSubstanceAdministrationParameterSequence()
default SubstanceAdministrationParameterSequence	ensureSubstanceAdministrationParameterSequence()	Adds a new Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence) with initial capacity 1 (see ensureSubstanceAdministrationParameterSequence(int)) if it does not already exist.
default SubstanceAdministrationParameterSequence	ensureSubstanceAdministrationParameterSequence(int initialCapacity)	Adds a new Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence) if it does not already exist.
default SubstanceAdministrationParameterSequence	getSubstanceAdministrationParameterSequence()
default SubstanceAdministrationParameterSequence	newSubstanceAdministrationParameterSequence(int initialCapacity)	Adds a new Substance Administration Parameter Sequence.
default void	removeSubstanceAdministrationParameterSequence()	Removes the Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence
static SubstanceAdministrationParameterSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence)

Returns:

a wrapper object implementing the SubstanceAdministrationParameterSequence.Holder interface.

builder

static SubstanceAdministrationParameterSequence.Holder.Builder builder()

Returns:

a SubstanceAdministrationParameterSequence.Holder.Builder to create Substance Administration Parameter Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a SubstanceAdministrationParameterSequence.Holder.Builder to create Substance Administration Parameter Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getSubstanceAdministrationParameterSequence

default SubstanceAdministrationParameterSequence getSubstanceAdministrationParameterSequence()

Returns:

the Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence)

newSubstanceAdministrationParameterSequence

default SubstanceAdministrationParameterSequence newSubstanceAdministrationParameterSequence(int initialCapacity)

Adds a new Substance Administration Parameter Sequence. (see SubstanceAdministrationParameterSequence)

Parameters:

initialCapacity - the initial capacity for the new Substance Administration Parameter Sequence

Returns:

the newly created SubstanceAdministrationParameterSequence.

ensureSubstanceAdministrationParameterSequence

default SubstanceAdministrationParameterSequence ensureSubstanceAdministrationParameterSequence(int initialCapacity)

Adds a new Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Substance Administration Parameter Sequence is created.

Returns:

either the already existing Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence) or a new one with capacity initialCapacity.

ensureSubstanceAdministrationParameterSequence

default SubstanceAdministrationParameterSequence ensureSubstanceAdministrationParameterSequence()

Adds a new Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence) with initial capacity 1 (see ensureSubstanceAdministrationParameterSequence(int)) if it does not already exist.

Returns:

either the already existing Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence) or a new one with capacity 1.

containsSubstanceAdministrationParameterSequence

default boolean containsSubstanceAdministrationParameterSequence()

Returns:

whether it contains the Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence)

removeSubstanceAdministrationParameterSequence

default void removeSubstanceAdministrationParameterSequence()

Removes the Substance Administration Parameter Sequence (see SubstanceAdministrationParameterSequence