Package org.dcm4che.typeddicom.dataelements

Interface InventoriedStudiesSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

InventoryModule

All Known Implementing Classes:

InventoryIOD, InventoryModule.SimpleWrapper

Enclosing class:

InventoriedStudiesSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Inventoried Studies Sequence" (see InventoriedStudiesSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InventoriedStudiesSequence.Holder.Builder	builder()
static InventoriedStudiesSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsInventoriedStudiesSequence()
default InventoriedStudiesSequence	ensureInventoriedStudiesSequence()	Adds a new Inventoried Studies Sequence (see InventoriedStudiesSequence) with initial capacity 1 (see ensureInventoriedStudiesSequence(int)) if it does not already exist.
default InventoriedStudiesSequence	ensureInventoriedStudiesSequence(int initialCapacity)	Adds a new Inventoried Studies Sequence (see InventoriedStudiesSequence) if it does not already exist.
default InventoriedStudiesSequence	getInventoriedStudiesSequence()
default InventoriedStudiesSequence	newInventoriedStudiesSequence(int initialCapacity)	Adds a new Inventoried Studies Sequence.
default void	removeInventoriedStudiesSequence()	Removes the Inventoried Studies Sequence (see InventoriedStudiesSequence
static InventoriedStudiesSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Inventoried Studies Sequence (see InventoriedStudiesSequence)

Returns:

a wrapper object implementing the InventoriedStudiesSequence.Holder interface.

builder

static InventoriedStudiesSequence.Holder.Builder builder()

Returns:

a InventoriedStudiesSequence.Holder.Builder to create Inventoried Studies Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getInventoriedStudiesSequence

default InventoriedStudiesSequence getInventoriedStudiesSequence()

Returns:

the Inventoried Studies Sequence (see InventoriedStudiesSequence)

newInventoriedStudiesSequence

default InventoriedStudiesSequence newInventoriedStudiesSequence(int initialCapacity)

Adds a new Inventoried Studies Sequence. (see InventoriedStudiesSequence)

Parameters:

initialCapacity - the initial capacity for the new Inventoried Studies Sequence

Returns:

the newly created InventoriedStudiesSequence.

ensureInventoriedStudiesSequence

default InventoriedStudiesSequence ensureInventoriedStudiesSequence(int initialCapacity)

Adds a new Inventoried Studies Sequence (see InventoriedStudiesSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Inventoried Studies Sequence (see InventoriedStudiesSequence) or a new one with capacity initialCapacity.

ensureInventoriedStudiesSequence

default InventoriedStudiesSequence ensureInventoriedStudiesSequence()

Adds a new Inventoried Studies Sequence (see InventoriedStudiesSequence) with initial capacity 1 (see ensureInventoriedStudiesSequence(int)) if it does not already exist.

Returns:

either the already existing Inventoried Studies Sequence (see InventoriedStudiesSequence) or a new one with capacity 1.

containsInventoriedStudiesSequence

default boolean containsInventoriedStudiesSequence()

Returns:

whether it contains the Inventoried Studies Sequence (see InventoriedStudiesSequence)

removeInventoriedStudiesSequence

default void removeInventoriedStudiesSequence()

Removes the Inventoried Studies Sequence (see InventoriedStudiesSequence