Package org.dcm4che.typeddicom.dataelements

Interface SpecimenReferenceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

SpecimenReferenceSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SpecimenReferenceSequence.Holder.Builder	builder()
static SpecimenReferenceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSpecimenReferenceSequence()
default SpecimenReferenceSequence	ensureSpecimenReferenceSequence()	Adds a new Specimen Reference Sequence (see SpecimenReferenceSequence) with initial capacity 1 (see ensureSpecimenReferenceSequence(int)) if it does not already exist.
default SpecimenReferenceSequence	ensureSpecimenReferenceSequence(int initialCapacity)	Adds a new Specimen Reference Sequence (see SpecimenReferenceSequence) if it does not already exist.
default SpecimenReferenceSequence	getSpecimenReferenceSequence()
default SpecimenReferenceSequence	newSpecimenReferenceSequence(int initialCapacity)	Adds a new Specimen Reference Sequence.
default void	removeSpecimenReferenceSequence()	Removes the Specimen Reference Sequence (see SpecimenReferenceSequence
static SpecimenReferenceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Specimen Reference Sequence (see SpecimenReferenceSequence)

Returns:

a wrapper object implementing the SpecimenReferenceSequence.Holder interface.

builder

static SpecimenReferenceSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getSpecimenReferenceSequence

default SpecimenReferenceSequence getSpecimenReferenceSequence()

Returns:

the Specimen Reference Sequence (see SpecimenReferenceSequence)

newSpecimenReferenceSequence

default SpecimenReferenceSequence newSpecimenReferenceSequence(int initialCapacity)

Adds a new Specimen Reference Sequence. (see SpecimenReferenceSequence)

Parameters:

initialCapacity - the initial capacity for the new Specimen Reference Sequence

Returns:

the newly created SpecimenReferenceSequence.

ensureSpecimenReferenceSequence

default SpecimenReferenceSequence ensureSpecimenReferenceSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureSpecimenReferenceSequence

default SpecimenReferenceSequence ensureSpecimenReferenceSequence()

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

Returns:

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

containsSpecimenReferenceSequence

default boolean containsSpecimenReferenceSequence()

Returns:

whether it contains the Specimen Reference Sequence (see SpecimenReferenceSequence)

removeSpecimenReferenceSequence

default void removeSpecimenReferenceSequence()

Removes the Specimen Reference Sequence (see SpecimenReferenceSequence