Package org.dcm4che.typeddicom.dataelements

Interface SpecimenPreparationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

SpecimenDescriptionSequence.Item

Enclosing class:

SpecimenPreparationSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SpecimenPreparationSequence.Holder.Builder	builder()
static SpecimenPreparationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSpecimenPreparationSequence()
default SpecimenPreparationSequence	ensureSpecimenPreparationSequence()	Adds a new Specimen Preparation Sequence (see SpecimenPreparationSequence) with initial capacity 1 (see ensureSpecimenPreparationSequence(int)) if it does not already exist.
default SpecimenPreparationSequence	ensureSpecimenPreparationSequence(int initialCapacity)	Adds a new Specimen Preparation Sequence (see SpecimenPreparationSequence) if it does not already exist.
default SpecimenPreparationSequence	getSpecimenPreparationSequence()
default SpecimenPreparationSequence	newSpecimenPreparationSequence(int initialCapacity)	Adds a new Specimen Preparation Sequence.
default void	removeSpecimenPreparationSequence()	Removes the Specimen Preparation Sequence (see SpecimenPreparationSequence
static SpecimenPreparationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Specimen Preparation Sequence (see SpecimenPreparationSequence)

Returns:

a wrapper object implementing the SpecimenPreparationSequence.Holder interface.

builder

static SpecimenPreparationSequence.Holder.Builder builder()

Returns:

a SpecimenPreparationSequence.Holder.Builder to create Specimen Preparation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getSpecimenPreparationSequence

default SpecimenPreparationSequence getSpecimenPreparationSequence()

Returns:

the Specimen Preparation Sequence (see SpecimenPreparationSequence)

newSpecimenPreparationSequence

default SpecimenPreparationSequence newSpecimenPreparationSequence(int initialCapacity)

Adds a new Specimen Preparation Sequence. (see SpecimenPreparationSequence)

Parameters:

initialCapacity - the initial capacity for the new Specimen Preparation Sequence

Returns:

the newly created SpecimenPreparationSequence.

ensureSpecimenPreparationSequence

default SpecimenPreparationSequence ensureSpecimenPreparationSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureSpecimenPreparationSequence

default SpecimenPreparationSequence ensureSpecimenPreparationSequence()

Adds a new Specimen Preparation Sequence (see SpecimenPreparationSequence) with initial capacity 1 (see ensureSpecimenPreparationSequence(int)) if it does not already exist.

Returns:

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

containsSpecimenPreparationSequence

default boolean containsSpecimenPreparationSequence()

Returns:

whether it contains the Specimen Preparation Sequence (see SpecimenPreparationSequence)

removeSpecimenPreparationSequence

default void removeSpecimenPreparationSequence()

Removes the Specimen Preparation Sequence (see SpecimenPreparationSequence