Package org.dcm4che.typeddicom.dataelements

Interface MultiFramePresentationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

XAXRFPresentationStatePresentationModule

All Known Implementing Classes:

XAXRFGrayscaleSoftcopyPresentationStateIOD, XAXRFPresentationStatePresentationModule.SimpleWrapper

Enclosing class:

MultiFramePresentationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Multi-frame Presentation Sequence" (see MultiFramePresentationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MultiFramePresentationSequence.Holder.Builder	builder()
static MultiFramePresentationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsMultiFramePresentationSequence()
default MultiFramePresentationSequence	ensureMultiFramePresentationSequence()	Adds a new Multi-frame Presentation Sequence (see MultiFramePresentationSequence) with initial capacity 1 (see ensureMultiFramePresentationSequence(int)) if it does not already exist.
default MultiFramePresentationSequence	ensureMultiFramePresentationSequence(int initialCapacity)	Adds a new Multi-frame Presentation Sequence (see MultiFramePresentationSequence) if it does not already exist.
default MultiFramePresentationSequence	getMultiFramePresentationSequence()
default MultiFramePresentationSequence	newMultiFramePresentationSequence(int initialCapacity)	Adds a new Multi-frame Presentation Sequence.
default void	removeMultiFramePresentationSequence()	Removes the Multi-frame Presentation Sequence (see MultiFramePresentationSequence
static MultiFramePresentationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Multi-frame Presentation Sequence (see MultiFramePresentationSequence)

Returns:

a wrapper object implementing the MultiFramePresentationSequence.Holder interface.

builder

static MultiFramePresentationSequence.Holder.Builder builder()

Returns:

a MultiFramePresentationSequence.Holder.Builder to create Multi-frame Presentation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a MultiFramePresentationSequence.Holder.Builder to create Multi-frame Presentation Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getMultiFramePresentationSequence

default MultiFramePresentationSequence getMultiFramePresentationSequence()

Returns:

the Multi-frame Presentation Sequence (see MultiFramePresentationSequence)

newMultiFramePresentationSequence

default MultiFramePresentationSequence newMultiFramePresentationSequence(int initialCapacity)

Adds a new Multi-frame Presentation Sequence. (see MultiFramePresentationSequence)

Parameters:

initialCapacity - the initial capacity for the new Multi-frame Presentation Sequence

Returns:

the newly created MultiFramePresentationSequence.

ensureMultiFramePresentationSequence

default MultiFramePresentationSequence ensureMultiFramePresentationSequence(int initialCapacity)

Adds a new Multi-frame Presentation Sequence (see MultiFramePresentationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Multi-frame Presentation Sequence (see MultiFramePresentationSequence) or a new one with capacity initialCapacity.

ensureMultiFramePresentationSequence

default MultiFramePresentationSequence ensureMultiFramePresentationSequence()

Adds a new Multi-frame Presentation Sequence (see MultiFramePresentationSequence) with initial capacity 1 (see ensureMultiFramePresentationSequence(int)) if it does not already exist.

Returns:

either the already existing Multi-frame Presentation Sequence (see MultiFramePresentationSequence) or a new one with capacity 1.

containsMultiFramePresentationSequence

default boolean containsMultiFramePresentationSequence()

Returns:

whether it contains the Multi-frame Presentation Sequence (see MultiFramePresentationSequence)

removeMultiFramePresentationSequence

default void removeMultiFramePresentationSequence()

Removes the Multi-frame Presentation Sequence (see MultiFramePresentationSequence