Package org.dcm4che.typeddicom.dataelements

Interface HistogramSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

ImageHistogramModule

All Known Implementing Classes:

DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, ImageHistogramModule.SimpleWrapper

Enclosing class:

HistogramSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Histogram Sequence" (see HistogramSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HistogramSequence.Holder.Builder	builder()
static HistogramSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsHistogramSequence()
default HistogramSequence	ensureHistogramSequence()	Adds a new Histogram Sequence (see HistogramSequence) with initial capacity 1 (see ensureHistogramSequence(int)) if it does not already exist.
default HistogramSequence	ensureHistogramSequence(int initialCapacity)	Adds a new Histogram Sequence (see HistogramSequence) if it does not already exist.
default HistogramSequence	getHistogramSequence()
default HistogramSequence	newHistogramSequence(int initialCapacity)	Adds a new Histogram Sequence.
default void	removeHistogramSequence()	Removes the Histogram Sequence (see HistogramSequence
static HistogramSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Histogram Sequence (see HistogramSequence)

Returns:

a wrapper object implementing the HistogramSequence.Holder interface.

builder

static HistogramSequence.Holder.Builder builder()

Returns:

a HistogramSequence.Holder.Builder to create Histogram Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getHistogramSequence

default HistogramSequence getHistogramSequence()

Returns:

the Histogram Sequence (see HistogramSequence)

newHistogramSequence

default HistogramSequence newHistogramSequence(int initialCapacity)

Adds a new Histogram Sequence. (see HistogramSequence)

Parameters:

initialCapacity - the initial capacity for the new Histogram Sequence

Returns:

the newly created HistogramSequence.

ensureHistogramSequence

default HistogramSequence ensureHistogramSequence(int initialCapacity)

Adds a new Histogram Sequence (see HistogramSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Histogram Sequence (see HistogramSequence) or a new one with capacity initialCapacity.

ensureHistogramSequence

default HistogramSequence ensureHistogramSequence()

Adds a new Histogram Sequence (see HistogramSequence) with initial capacity 1 (see ensureHistogramSequence(int)) if it does not already exist.

Returns:

either the already existing Histogram Sequence (see HistogramSequence) or a new one with capacity 1.

containsHistogramSequence

default boolean containsHistogramSequence()

Returns:

whether it contains the Histogram Sequence (see HistogramSequence)

removeHistogramSequence

default void removeHistogramSequence()

Removes the Histogram Sequence (see HistogramSequence