Package org.dcm4che.typeddicom.dataelements

Interface ContributingSourcesSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

BreastTomosynthesisContributingSourcesModule, XRay3DAngiographicImageContributingSourcesModule, XRay3DCraniofacialImageContributingSourcesModule

All Known Implementing Classes:

BreastTomosynthesisImageIOD, ContributingSourcesSequence.SimpleHolder, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD

Enclosing class:

ContributingSourcesSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Contributing Sources Sequence" (see ContributingSourcesSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContributingSourcesSequence.Holder.Builder	builder()
static ContributingSourcesSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsContributingSourcesSequence()
default ContributingSourcesSequence	ensureContributingSourcesSequence()	Adds a new Contributing Sources Sequence (see ContributingSourcesSequence) with initial capacity 1 (see ensureContributingSourcesSequence(int)) if it does not already exist.
default ContributingSourcesSequence	ensureContributingSourcesSequence(int initialCapacity)	Adds a new Contributing Sources Sequence (see ContributingSourcesSequence) if it does not already exist.
default ContributingSourcesSequence	getContributingSourcesSequence()
default ContributingSourcesSequence	newContributingSourcesSequence(int initialCapacity)	Adds a new Contributing Sources Sequence.
default void	removeContributingSourcesSequence()	Removes the Contributing Sources Sequence (see ContributingSourcesSequence
static ContributingSourcesSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Contributing Sources Sequence (see ContributingSourcesSequence)

Returns:

a wrapper object implementing the ContributingSourcesSequence.Holder interface.

builder

static ContributingSourcesSequence.Holder.Builder builder()

Returns:

a ContributingSourcesSequence.Holder.Builder to create Contributing Sources Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getContributingSourcesSequence

default ContributingSourcesSequence getContributingSourcesSequence()

Returns:

the Contributing Sources Sequence (see ContributingSourcesSequence)

newContributingSourcesSequence

default ContributingSourcesSequence newContributingSourcesSequence(int initialCapacity)

Adds a new Contributing Sources Sequence. (see ContributingSourcesSequence)

Parameters:

initialCapacity - the initial capacity for the new Contributing Sources Sequence

Returns:

the newly created ContributingSourcesSequence.

ensureContributingSourcesSequence

default ContributingSourcesSequence ensureContributingSourcesSequence(int initialCapacity)

Adds a new Contributing Sources Sequence (see ContributingSourcesSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Contributing Sources Sequence (see ContributingSourcesSequence) or a new one with capacity initialCapacity.

ensureContributingSourcesSequence

default ContributingSourcesSequence ensureContributingSourcesSequence()

Adds a new Contributing Sources Sequence (see ContributingSourcesSequence) with initial capacity 1 (see ensureContributingSourcesSequence(int)) if it does not already exist.

Returns:

either the already existing Contributing Sources Sequence (see ContributingSourcesSequence) or a new one with capacity 1.

containsContributingSourcesSequence

default boolean containsContributingSourcesSequence()

Returns:

whether it contains the Contributing Sources Sequence (see ContributingSourcesSequence)

removeContributingSourcesSequence

default void removeContributingSourcesSequence()

Removes the Contributing Sources Sequence (see ContributingSourcesSequence