Package org.dcm4che.typeddicom.dataelements

Interface EquivalentCDADocumentSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

EquivalentCDADocumentSequence.SimpleHolder

Enclosing class:

EquivalentCDADocumentSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Equivalent CDA Document Sequence" (see EquivalentCDADocumentSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EquivalentCDADocumentSequence.Holder.Builder	builder()
static EquivalentCDADocumentSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsEquivalentCDADocumentSequence()
default EquivalentCDADocumentSequence	ensureEquivalentCDADocumentSequence()	Adds a new Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence) with initial capacity 1 (see ensureEquivalentCDADocumentSequence(int)) if it does not already exist.
default EquivalentCDADocumentSequence	ensureEquivalentCDADocumentSequence(int initialCapacity)	Adds a new Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence) if it does not already exist.
default EquivalentCDADocumentSequence	getEquivalentCDADocumentSequence()
default EquivalentCDADocumentSequence	newEquivalentCDADocumentSequence(int initialCapacity)	Adds a new Equivalent CDA Document Sequence.
default void	removeEquivalentCDADocumentSequence()	Removes the Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence
static EquivalentCDADocumentSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence)

Returns:

a wrapper object implementing the EquivalentCDADocumentSequence.Holder interface.

builder

static EquivalentCDADocumentSequence.Holder.Builder builder()

Returns:

a EquivalentCDADocumentSequence.Holder.Builder to create Equivalent CDA Document Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a EquivalentCDADocumentSequence.Holder.Builder to create Equivalent CDA Document Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getEquivalentCDADocumentSequence

default EquivalentCDADocumentSequence getEquivalentCDADocumentSequence()

Returns:

the Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence)

newEquivalentCDADocumentSequence

default EquivalentCDADocumentSequence newEquivalentCDADocumentSequence(int initialCapacity)

Adds a new Equivalent CDA Document Sequence. (see EquivalentCDADocumentSequence)

Parameters:

initialCapacity - the initial capacity for the new Equivalent CDA Document Sequence

Returns:

the newly created EquivalentCDADocumentSequence.

ensureEquivalentCDADocumentSequence

default EquivalentCDADocumentSequence ensureEquivalentCDADocumentSequence(int initialCapacity)

Adds a new Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence) or a new one with capacity initialCapacity.

ensureEquivalentCDADocumentSequence

default EquivalentCDADocumentSequence ensureEquivalentCDADocumentSequence()

Adds a new Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence) with initial capacity 1 (see ensureEquivalentCDADocumentSequence(int)) if it does not already exist.

Returns:

either the already existing Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence) or a new one with capacity 1.

containsEquivalentCDADocumentSequence

default boolean containsEquivalentCDADocumentSequence()

Returns:

whether it contains the Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence)

removeEquivalentCDADocumentSequence

default void removeEquivalentCDADocumentSequence()

Removes the Equivalent CDA Document Sequence (see EquivalentCDADocumentSequence