Package org.dcm4che.typeddicom.dataelements

Interface ImageSetsSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

HangingProtocolDefinitionModule

All Known Implementing Classes:

HangingProtocolDefinitionModule.SimpleWrapper, HangingProtocolIOD

Enclosing class:

ImageSetsSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Image Sets Sequence" (see ImageSetsSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImageSetsSequence.Holder.Builder	builder()
static ImageSetsSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsImageSetsSequence()
default ImageSetsSequence	ensureImageSetsSequence()	Adds a new Image Sets Sequence (see ImageSetsSequence) with initial capacity 1 (see ensureImageSetsSequence(int)) if it does not already exist.
default ImageSetsSequence	ensureImageSetsSequence(int initialCapacity)	Adds a new Image Sets Sequence (see ImageSetsSequence) if it does not already exist.
default ImageSetsSequence	getImageSetsSequence()
default ImageSetsSequence	newImageSetsSequence(int initialCapacity)	Adds a new Image Sets Sequence.
default void	removeImageSetsSequence()	Removes the Image Sets Sequence (see ImageSetsSequence
static ImageSetsSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Image Sets Sequence (see ImageSetsSequence)

Returns:

a wrapper object implementing the ImageSetsSequence.Holder interface.

builder

static ImageSetsSequence.Holder.Builder builder()

Returns:

a ImageSetsSequence.Holder.Builder to create Image Sets Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getImageSetsSequence

default ImageSetsSequence getImageSetsSequence()

Returns:

the Image Sets Sequence (see ImageSetsSequence)

newImageSetsSequence

default ImageSetsSequence newImageSetsSequence(int initialCapacity)

Adds a new Image Sets Sequence. (see ImageSetsSequence)

Parameters:

initialCapacity - the initial capacity for the new Image Sets Sequence

Returns:

the newly created ImageSetsSequence.

ensureImageSetsSequence

default ImageSetsSequence ensureImageSetsSequence(int initialCapacity)

Adds a new Image Sets Sequence (see ImageSetsSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Image Sets Sequence (see ImageSetsSequence) or a new one with capacity initialCapacity.

ensureImageSetsSequence

default ImageSetsSequence ensureImageSetsSequence()

Adds a new Image Sets Sequence (see ImageSetsSequence) with initial capacity 1 (see ensureImageSetsSequence(int)) if it does not already exist.

Returns:

either the already existing Image Sets Sequence (see ImageSetsSequence) or a new one with capacity 1.

containsImageSetsSequence

default boolean containsImageSetsSequence()

Returns:

whether it contains the Image Sets Sequence (see ImageSetsSequence)

removeImageSetsSequence

default void removeImageSetsSequence()

Removes the Image Sets Sequence (see ImageSetsSequence