Package org.dcm4che.typeddicom.dataelements

Interface MetadataSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

MetadataSequence.SimpleHolder

Enclosing class:

MetadataSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MetadataSequence.Holder.Builder	builder()
static MetadataSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsMetadataSequence()
default MetadataSequence	ensureMetadataSequence()	Adds a new Metadata Sequence (see MetadataSequence) with initial capacity 1 (see ensureMetadataSequence(int)) if it does not already exist.
default MetadataSequence	ensureMetadataSequence(int initialCapacity)	Adds a new Metadata Sequence (see MetadataSequence) if it does not already exist.
default MetadataSequence	getMetadataSequence()
default MetadataSequence	newMetadataSequence(int initialCapacity)	Adds a new Metadata Sequence.
default void	removeMetadataSequence()	Removes the Metadata Sequence (see MetadataSequence
static MetadataSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Metadata Sequence (see MetadataSequence)

Returns:

a wrapper object implementing the MetadataSequence.Holder interface.

builder

static MetadataSequence.Holder.Builder builder()

Returns:

a MetadataSequence.Holder.Builder to create Metadata Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getMetadataSequence

default MetadataSequence getMetadataSequence()

Returns:

the Metadata Sequence (see MetadataSequence)

newMetadataSequence

default MetadataSequence newMetadataSequence(int initialCapacity)

Adds a new Metadata Sequence. (see MetadataSequence)

Parameters:

initialCapacity - the initial capacity for the new Metadata Sequence

Returns:

the newly created MetadataSequence.

ensureMetadataSequence

default MetadataSequence ensureMetadataSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureMetadataSequence

default MetadataSequence ensureMetadataSequence()

Adds a new Metadata Sequence (see MetadataSequence) with initial capacity 1 (see ensureMetadataSequence(int)) if it does not already exist.

Returns:

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

containsMetadataSequence

default boolean containsMetadataSequence()

Returns:

whether it contains the Metadata Sequence (see MetadataSequence)

removeMetadataSequence

default void removeMetadataSequence()

Removes the Metadata Sequence (see MetadataSequence