Package org.dcm4che.typeddicom.dataelements

Interface ScheduledSpecimenSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

ScheduledProcedureStepModule

All Known Implementing Classes:

ScheduledProcedureStepModule.SimpleWrapper

Enclosing class:

ScheduledSpecimenSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Scheduled Specimen Sequence" (see ScheduledSpecimenSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ScheduledSpecimenSequence.Holder.Builder	builder()
static ScheduledSpecimenSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsScheduledSpecimenSequence()
default ScheduledSpecimenSequence	ensureScheduledSpecimenSequence()	Adds a new Scheduled Specimen Sequence (see ScheduledSpecimenSequence) with initial capacity 1 (see ensureScheduledSpecimenSequence(int)) if it does not already exist.
default ScheduledSpecimenSequence	ensureScheduledSpecimenSequence(int initialCapacity)	Adds a new Scheduled Specimen Sequence (see ScheduledSpecimenSequence) if it does not already exist.
default ScheduledSpecimenSequence	getScheduledSpecimenSequence()
default ScheduledSpecimenSequence	newScheduledSpecimenSequence(int initialCapacity)	Adds a new Scheduled Specimen Sequence.
default void	removeScheduledSpecimenSequence()	Removes the Scheduled Specimen Sequence (see ScheduledSpecimenSequence
static ScheduledSpecimenSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Scheduled Specimen Sequence (see ScheduledSpecimenSequence)

Returns:

a wrapper object implementing the ScheduledSpecimenSequence.Holder interface.

builder

static ScheduledSpecimenSequence.Holder.Builder builder()

Returns:

a ScheduledSpecimenSequence.Holder.Builder to create Scheduled Specimen Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ScheduledSpecimenSequence.Holder.Builder to create Scheduled Specimen Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getScheduledSpecimenSequence

default ScheduledSpecimenSequence getScheduledSpecimenSequence()

Returns:

the Scheduled Specimen Sequence (see ScheduledSpecimenSequence)

newScheduledSpecimenSequence

default ScheduledSpecimenSequence newScheduledSpecimenSequence(int initialCapacity)

Adds a new Scheduled Specimen Sequence. (see ScheduledSpecimenSequence)

Parameters:

initialCapacity - the initial capacity for the new Scheduled Specimen Sequence

Returns:

the newly created ScheduledSpecimenSequence.

ensureScheduledSpecimenSequence

default ScheduledSpecimenSequence ensureScheduledSpecimenSequence(int initialCapacity)

Adds a new Scheduled Specimen Sequence (see ScheduledSpecimenSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Scheduled Specimen Sequence (see ScheduledSpecimenSequence) or a new one with capacity initialCapacity.

ensureScheduledSpecimenSequence

default ScheduledSpecimenSequence ensureScheduledSpecimenSequence()

Adds a new Scheduled Specimen Sequence (see ScheduledSpecimenSequence) with initial capacity 1 (see ensureScheduledSpecimenSequence(int)) if it does not already exist.

Returns:

either the already existing Scheduled Specimen Sequence (see ScheduledSpecimenSequence) or a new one with capacity 1.

containsScheduledSpecimenSequence

default boolean containsScheduledSpecimenSequence()

Returns:

whether it contains the Scheduled Specimen Sequence (see ScheduledSpecimenSequence)

removeScheduledSpecimenSequence

default void removeScheduledSpecimenSequence()

Removes the Scheduled Specimen Sequence (see ScheduledSpecimenSequence