Package org.dcm4che.typeddicom.dataelements

Interface SurfaceSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

SurfaceMeshModule

All Known Implementing Classes:

GenericImplantTemplateIOD, SurfaceScanMeshIOD, SurfaceSegmentationIOD, SurfaceSequence.SimpleHolder

Enclosing class:

SurfaceSequence

public static interface SurfaceSequence.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SurfaceSequence.Holder.Builder	builder()
static SurfaceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSurfaceSequence()
default SurfaceSequence	ensureSurfaceSequence()	Adds a new Surface Sequence (see SurfaceSequence) with initial capacity 1 (see ensureSurfaceSequence(int)) if it does not already exist.
default SurfaceSequence	ensureSurfaceSequence(int initialCapacity)	Adds a new Surface Sequence (see SurfaceSequence) if it does not already exist.
default SurfaceSequence	getSurfaceSequence()
default SurfaceSequence	newSurfaceSequence(int initialCapacity)	Adds a new Surface Sequence.
default void	removeSurfaceSequence()	Removes the Surface Sequence (see SurfaceSequence
static SurfaceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Surface Sequence (see SurfaceSequence)

Returns:

A wrapper object implementing the SurfaceSequence.Holder interface.

builder

static SurfaceSequence.Holder.Builder builder()

Returns:

a SurfaceSequence.Holder.Builder to create Surface Sequence Items with a fluent API.

builder

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

Parameters:

attributes - The Attributes to be wrapped by the SurfaceSequence.Holder.Builder.

Returns:

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

getSurfaceSequence

default SurfaceSequence getSurfaceSequence()

Returns:

the Surface Sequence (see SurfaceSequence)

newSurfaceSequence

default SurfaceSequence newSurfaceSequence(int initialCapacity)

Adds a new Surface Sequence. (see SurfaceSequence)

Parameters:

initialCapacity - the initial capacity for the new Surface Sequence

ensureSurfaceSequence

default SurfaceSequence ensureSurfaceSequence(int initialCapacity)

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

Parameters:

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

Returns:

Either the already existing Surface Sequence (see SurfaceSequence) or a new one with capacity initialCapacity.

ensureSurfaceSequence

default SurfaceSequence ensureSurfaceSequence()

Adds a new Surface Sequence (see SurfaceSequence) with initial capacity 1 (see ensureSurfaceSequence(int)) if it does not already exist.

Returns:

Either the already existing Surface Sequence (see SurfaceSequence) or a new one with capacity 1.

containsSurfaceSequence

default boolean containsSurfaceSequence()

Returns:

Whether it contains the Surface Sequence (see SurfaceSequence)

removeSurfaceSequence

default void removeSurfaceSequence()

Removes the Surface Sequence (see SurfaceSequence