Package org.dcm4che.typeddicom.dataelements

Interface RelativeImagePositionCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

OcularRegionImagedModule, OphthalmicThicknessMapModule

All Known Implementing Classes:

OcularRegionImagedModule.SimpleWrapper, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, OphthalmicThicknessMapModule.SimpleWrapper, OphthalmicTomographyImageIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD

Enclosing class:

RelativeImagePositionCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Relative Image Position Code Sequence" (see RelativeImagePositionCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RelativeImagePositionCodeSequence.Holder.Builder	builder()
static RelativeImagePositionCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRelativeImagePositionCodeSequence()
default RelativeImagePositionCodeSequence	ensureRelativeImagePositionCodeSequence()	Adds a new Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence) with initial capacity 1 (see ensureRelativeImagePositionCodeSequence(int)) if it does not already exist.
default RelativeImagePositionCodeSequence	ensureRelativeImagePositionCodeSequence(int initialCapacity)	Adds a new Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence) if it does not already exist.
default RelativeImagePositionCodeSequence	getRelativeImagePositionCodeSequence()
default RelativeImagePositionCodeSequence	newRelativeImagePositionCodeSequence(int initialCapacity)	Adds a new Relative Image Position Code Sequence.
default void	removeRelativeImagePositionCodeSequence()	Removes the Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence
static RelativeImagePositionCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence)

Returns:

a wrapper object implementing the RelativeImagePositionCodeSequence.Holder interface.

builder

static RelativeImagePositionCodeSequence.Holder.Builder builder()

Returns:

a RelativeImagePositionCodeSequence.Holder.Builder to create Relative Image Position Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a RelativeImagePositionCodeSequence.Holder.Builder to create Relative Image Position Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRelativeImagePositionCodeSequence

default RelativeImagePositionCodeSequence getRelativeImagePositionCodeSequence()

Returns:

the Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence)

newRelativeImagePositionCodeSequence

default RelativeImagePositionCodeSequence newRelativeImagePositionCodeSequence(int initialCapacity)

Adds a new Relative Image Position Code Sequence. (see RelativeImagePositionCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Relative Image Position Code Sequence

Returns:

the newly created RelativeImagePositionCodeSequence.

ensureRelativeImagePositionCodeSequence

default RelativeImagePositionCodeSequence ensureRelativeImagePositionCodeSequence(int initialCapacity)

Adds a new Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Relative Image Position Code Sequence is created.

Returns:

either the already existing Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence) or a new one with capacity initialCapacity.

ensureRelativeImagePositionCodeSequence

default RelativeImagePositionCodeSequence ensureRelativeImagePositionCodeSequence()

Adds a new Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence) with initial capacity 1 (see ensureRelativeImagePositionCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence) or a new one with capacity 1.

containsRelativeImagePositionCodeSequence

default boolean containsRelativeImagePositionCodeSequence()

Returns:

whether it contains the Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence)

removeRelativeImagePositionCodeSequence

default void removeRelativeImagePositionCodeSequence()

Removes the Relative Image Position Code Sequence (see RelativeImagePositionCodeSequence