Package org.dcm4che.typeddicom.dataelements

Interface ChannelDescriptionCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

OphthalmicPhotographicParametersModule, VLImageModule

All Known Implementing Classes:

DermoscopicPhotographyImageIOD, OphthalmicPhotographicParametersModule.SimpleWrapper, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OpticalPathSequence.Item, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLImageModule.SimpleWrapper, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

Enclosing class:

ChannelDescriptionCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Channel Description Code Sequence" (see ChannelDescriptionCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ChannelDescriptionCodeSequence.Holder.Builder	builder()
static ChannelDescriptionCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsChannelDescriptionCodeSequence()
default ChannelDescriptionCodeSequence	ensureChannelDescriptionCodeSequence()	Adds a new Channel Description Code Sequence (see ChannelDescriptionCodeSequence) with initial capacity 1 (see ensureChannelDescriptionCodeSequence(int)) if it does not already exist.
default ChannelDescriptionCodeSequence	ensureChannelDescriptionCodeSequence(int initialCapacity)	Adds a new Channel Description Code Sequence (see ChannelDescriptionCodeSequence) if it does not already exist.
default ChannelDescriptionCodeSequence	getChannelDescriptionCodeSequence()
default ChannelDescriptionCodeSequence	newChannelDescriptionCodeSequence(int initialCapacity)	Adds a new Channel Description Code Sequence.
default void	removeChannelDescriptionCodeSequence()	Removes the Channel Description Code Sequence (see ChannelDescriptionCodeSequence
static ChannelDescriptionCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Channel Description Code Sequence (see ChannelDescriptionCodeSequence)

Returns:

a wrapper object implementing the ChannelDescriptionCodeSequence.Holder interface.

builder

static ChannelDescriptionCodeSequence.Holder.Builder builder()

Returns:

a ChannelDescriptionCodeSequence.Holder.Builder to create Channel Description Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ChannelDescriptionCodeSequence.Holder.Builder to create Channel Description Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getChannelDescriptionCodeSequence

default ChannelDescriptionCodeSequence getChannelDescriptionCodeSequence()

Returns:

the Channel Description Code Sequence (see ChannelDescriptionCodeSequence)

newChannelDescriptionCodeSequence

default ChannelDescriptionCodeSequence newChannelDescriptionCodeSequence(int initialCapacity)

Adds a new Channel Description Code Sequence. (see ChannelDescriptionCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Channel Description Code Sequence

Returns:

the newly created ChannelDescriptionCodeSequence.

ensureChannelDescriptionCodeSequence

default ChannelDescriptionCodeSequence ensureChannelDescriptionCodeSequence(int initialCapacity)

Adds a new Channel Description Code Sequence (see ChannelDescriptionCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Channel Description Code Sequence (see ChannelDescriptionCodeSequence) or a new one with capacity initialCapacity.

ensureChannelDescriptionCodeSequence

default ChannelDescriptionCodeSequence ensureChannelDescriptionCodeSequence()

Adds a new Channel Description Code Sequence (see ChannelDescriptionCodeSequence) with initial capacity 1 (see ensureChannelDescriptionCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Channel Description Code Sequence (see ChannelDescriptionCodeSequence) or a new one with capacity 1.

containsChannelDescriptionCodeSequence

default boolean containsChannelDescriptionCodeSequence()

Returns:

whether it contains the Channel Description Code Sequence (see ChannelDescriptionCodeSequence)

removeChannelDescriptionCodeSequence

default void removeChannelDescriptionCodeSequence()

Removes the Channel Description Code Sequence (see ChannelDescriptionCodeSequence