Package org.dcm4che.typeddicom.dataelements

Interface DisplayedAreaSelectionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

DisplayedAreaModule

All Known Implementing Classes:

AdvancedBlendingPresentationStateIOD, BlendingSoftcopyPresentationStateIOD, ColorSoftcopyPresentationStateIOD, DisplayedAreaSelectionSequence.SimpleHolder, GrayscaleSoftcopyPresentationStateIOD, PseudoColorSoftcopyPresentationStateIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD

Enclosing class:

DisplayedAreaSelectionSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Displayed Area Selection Sequence" (see DisplayedAreaSelectionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DisplayedAreaSelectionSequence.Holder.Builder	builder()
static DisplayedAreaSelectionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDisplayedAreaSelectionSequence()
default DisplayedAreaSelectionSequence	ensureDisplayedAreaSelectionSequence()	Adds a new Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence) with initial capacity 1 (see ensureDisplayedAreaSelectionSequence(int)) if it does not already exist.
default DisplayedAreaSelectionSequence	ensureDisplayedAreaSelectionSequence(int initialCapacity)	Adds a new Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence) if it does not already exist.
default DisplayedAreaSelectionSequence	getDisplayedAreaSelectionSequence()
default DisplayedAreaSelectionSequence	newDisplayedAreaSelectionSequence(int initialCapacity)	Adds a new Displayed Area Selection Sequence.
default void	removeDisplayedAreaSelectionSequence()	Removes the Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence
static DisplayedAreaSelectionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence)

Returns:

a wrapper object implementing the DisplayedAreaSelectionSequence.Holder interface.

builder

static DisplayedAreaSelectionSequence.Holder.Builder builder()

Returns:

a DisplayedAreaSelectionSequence.Holder.Builder to create Displayed Area Selection Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a DisplayedAreaSelectionSequence.Holder.Builder to create Displayed Area Selection Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getDisplayedAreaSelectionSequence

default DisplayedAreaSelectionSequence getDisplayedAreaSelectionSequence()

Returns:

the Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence)

newDisplayedAreaSelectionSequence

default DisplayedAreaSelectionSequence newDisplayedAreaSelectionSequence(int initialCapacity)

Adds a new Displayed Area Selection Sequence. (see DisplayedAreaSelectionSequence)

Parameters:

initialCapacity - the initial capacity for the new Displayed Area Selection Sequence

Returns:

the newly created DisplayedAreaSelectionSequence.

ensureDisplayedAreaSelectionSequence

default DisplayedAreaSelectionSequence ensureDisplayedAreaSelectionSequence(int initialCapacity)

Adds a new Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence) or a new one with capacity initialCapacity.

ensureDisplayedAreaSelectionSequence

default DisplayedAreaSelectionSequence ensureDisplayedAreaSelectionSequence()

Adds a new Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence) with initial capacity 1 (see ensureDisplayedAreaSelectionSequence(int)) if it does not already exist.

Returns:

either the already existing Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence) or a new one with capacity 1.

containsDisplayedAreaSelectionSequence

default boolean containsDisplayedAreaSelectionSequence()

Returns:

whether it contains the Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence)

removeDisplayedAreaSelectionSequence

default void removeDisplayedAreaSelectionSequence()

Removes the Displayed Area Selection Sequence (see DisplayedAreaSelectionSequence