Package org.dcm4che.typeddicom.dataelements

Interface DirectoryRecordSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

DirectoryInformationModule

All Known Implementing Classes:

DirectoryInformationModule.SimpleWrapper

Enclosing class:

DirectoryRecordSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Directory Record Sequence" (see DirectoryRecordSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DirectoryRecordSequence.Holder.Builder	builder()
static DirectoryRecordSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDirectoryRecordSequence()
default DirectoryRecordSequence	ensureDirectoryRecordSequence()	Adds a new Directory Record Sequence (see DirectoryRecordSequence) with initial capacity 1 (see ensureDirectoryRecordSequence(int)) if it does not already exist.
default DirectoryRecordSequence	ensureDirectoryRecordSequence(int initialCapacity)	Adds a new Directory Record Sequence (see DirectoryRecordSequence) if it does not already exist.
default DirectoryRecordSequence	getDirectoryRecordSequence()
default DirectoryRecordSequence	newDirectoryRecordSequence(int initialCapacity)	Adds a new Directory Record Sequence.
default void	removeDirectoryRecordSequence()	Removes the Directory Record Sequence (see DirectoryRecordSequence
static DirectoryRecordSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Directory Record Sequence (see DirectoryRecordSequence)

Returns:

a wrapper object implementing the DirectoryRecordSequence.Holder interface.

builder

static DirectoryRecordSequence.Holder.Builder builder()

Returns:

a DirectoryRecordSequence.Holder.Builder to create Directory Record Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDirectoryRecordSequence

default DirectoryRecordSequence getDirectoryRecordSequence()

Returns:

the Directory Record Sequence (see DirectoryRecordSequence)

newDirectoryRecordSequence

default DirectoryRecordSequence newDirectoryRecordSequence(int initialCapacity)

Adds a new Directory Record Sequence. (see DirectoryRecordSequence)

Parameters:

initialCapacity - the initial capacity for the new Directory Record Sequence

Returns:

the newly created DirectoryRecordSequence.

ensureDirectoryRecordSequence

default DirectoryRecordSequence ensureDirectoryRecordSequence(int initialCapacity)

Adds a new Directory Record Sequence (see DirectoryRecordSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Directory Record Sequence (see DirectoryRecordSequence) or a new one with capacity initialCapacity.

ensureDirectoryRecordSequence

default DirectoryRecordSequence ensureDirectoryRecordSequence()

Adds a new Directory Record Sequence (see DirectoryRecordSequence) with initial capacity 1 (see ensureDirectoryRecordSequence(int)) if it does not already exist.

Returns:

either the already existing Directory Record Sequence (see DirectoryRecordSequence) or a new one with capacity 1.

containsDirectoryRecordSequence

default boolean containsDirectoryRecordSequence()

Returns:

whether it contains the Directory Record Sequence (see DirectoryRecordSequence)

removeDirectoryRecordSequence

default void removeDirectoryRecordSequence()

Removes the Directory Record Sequence (see DirectoryRecordSequence