Package org.dcm4che.typeddicom.dataelements

Interface SpecimenSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

SpecimenSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SpecimenSequence.Holder.Builder	builder()
static SpecimenSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSpecimenSequence()
default SpecimenSequence	ensureSpecimenSequence()	Adds a new Specimen Sequence (see SpecimenSequence) with initial capacity 1 (see ensureSpecimenSequence(int)) if it does not already exist.
default SpecimenSequence	ensureSpecimenSequence(int initialCapacity)	Adds a new Specimen Sequence (see SpecimenSequence) if it does not already exist.
default SpecimenSequence	getSpecimenSequence()
default SpecimenSequence	newSpecimenSequence(int initialCapacity)	Adds a new Specimen Sequence.
default void	removeSpecimenSequence()	Removes the Specimen Sequence (see SpecimenSequence
static SpecimenSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Specimen Sequence (see SpecimenSequence)

Returns:

a wrapper object implementing the SpecimenSequence.Holder interface.

builder

static SpecimenSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getSpecimenSequence

default SpecimenSequence getSpecimenSequence()

Returns:

the Specimen Sequence (see SpecimenSequence)

newSpecimenSequence

default SpecimenSequence newSpecimenSequence(int initialCapacity)

Adds a new Specimen Sequence. (see SpecimenSequence)

Parameters:

initialCapacity - the initial capacity for the new Specimen Sequence

Returns:

the newly created SpecimenSequence.

ensureSpecimenSequence

default SpecimenSequence ensureSpecimenSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureSpecimenSequence

default SpecimenSequence ensureSpecimenSequence()

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

Returns:

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

containsSpecimenSequence

default boolean containsSpecimenSequence()

Returns:

whether it contains the Specimen Sequence (see SpecimenSequence)

removeSpecimenSequence

default void removeSpecimenSequence()

Removes the Specimen Sequence (see SpecimenSequence