Package org.dcm4che.typeddicom.dataelements

Interface FacetSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

FacetSequence.SimpleHolder, SurfaceMeshPrimitivesSequence.Item

Enclosing class:

FacetSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FacetSequence.Holder.Builder	builder()
static FacetSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFacetSequence()
default FacetSequence	ensureFacetSequence()	Adds a new Facet Sequence (see FacetSequence) with initial capacity 1 (see ensureFacetSequence(int)) if it does not already exist.
default FacetSequence	ensureFacetSequence(int initialCapacity)	Adds a new Facet Sequence (see FacetSequence) if it does not already exist.
default FacetSequence	getFacetSequence()
default FacetSequence	newFacetSequence(int initialCapacity)	Adds a new Facet Sequence.
default void	removeFacetSequence()	Removes the Facet Sequence (see FacetSequence
static FacetSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Facet Sequence (see FacetSequence)

Returns:

a wrapper object implementing the FacetSequence.Holder interface.

builder

static FacetSequence.Holder.Builder builder()

Returns:

a FacetSequence.Holder.Builder to create Facet Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFacetSequence

default FacetSequence getFacetSequence()

Returns:

the Facet Sequence (see FacetSequence)

newFacetSequence

default FacetSequence newFacetSequence(int initialCapacity)

Adds a new Facet Sequence. (see FacetSequence)

Parameters:

initialCapacity - the initial capacity for the new Facet Sequence

Returns:

the newly created FacetSequence.

ensureFacetSequence

default FacetSequence ensureFacetSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureFacetSequence

default FacetSequence ensureFacetSequence()

Adds a new Facet Sequence (see FacetSequence) with initial capacity 1 (see ensureFacetSequence(int)) if it does not already exist.

Returns:

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

containsFacetSequence

default boolean containsFacetSequence()

Returns:

whether it contains the Facet Sequence (see FacetSequence)

removeFacetSequence

default void removeFacetSequence()

Removes the Facet Sequence (see FacetSequence