Package org.dcm4che.typeddicom.dataelements

Interface PlaneOrientationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

CurrentFrameFunctionalGroupsSequence.Item, PerFrameFunctionalGroupsSequence.Item, SelectedFrameFunctionalGroupsSequence.Item, SharedFunctionalGroupsSequence.Item

Enclosing class:

PlaneOrientationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Plane Orientation Sequence" (see PlaneOrientationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PlaneOrientationSequence.Holder.Builder	builder()
static PlaneOrientationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPlaneOrientationSequence()
default PlaneOrientationSequence	ensurePlaneOrientationSequence()	Adds a new Plane Orientation Sequence (see PlaneOrientationSequence) with initial capacity 1 (see ensurePlaneOrientationSequence(int)) if it does not already exist.
default PlaneOrientationSequence	ensurePlaneOrientationSequence(int initialCapacity)	Adds a new Plane Orientation Sequence (see PlaneOrientationSequence) if it does not already exist.
default PlaneOrientationSequence	getPlaneOrientationSequence()
default PlaneOrientationSequence	newPlaneOrientationSequence(int initialCapacity)	Adds a new Plane Orientation Sequence.
default void	removePlaneOrientationSequence()	Removes the Plane Orientation Sequence (see PlaneOrientationSequence
static PlaneOrientationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Plane Orientation Sequence (see PlaneOrientationSequence)

Returns:

a wrapper object implementing the PlaneOrientationSequence.Holder interface.

builder

static PlaneOrientationSequence.Holder.Builder builder()

Returns:

a PlaneOrientationSequence.Holder.Builder to create Plane Orientation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPlaneOrientationSequence

default PlaneOrientationSequence getPlaneOrientationSequence()

Returns:

the Plane Orientation Sequence (see PlaneOrientationSequence)

newPlaneOrientationSequence

default PlaneOrientationSequence newPlaneOrientationSequence(int initialCapacity)

Adds a new Plane Orientation Sequence. (see PlaneOrientationSequence)

Parameters:

initialCapacity - the initial capacity for the new Plane Orientation Sequence

Returns:

the newly created PlaneOrientationSequence.

ensurePlaneOrientationSequence

default PlaneOrientationSequence ensurePlaneOrientationSequence(int initialCapacity)

Adds a new Plane Orientation Sequence (see PlaneOrientationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Plane Orientation Sequence (see PlaneOrientationSequence) or a new one with capacity initialCapacity.

ensurePlaneOrientationSequence

default PlaneOrientationSequence ensurePlaneOrientationSequence()

Adds a new Plane Orientation Sequence (see PlaneOrientationSequence) with initial capacity 1 (see ensurePlaneOrientationSequence(int)) if it does not already exist.

Returns:

either the already existing Plane Orientation Sequence (see PlaneOrientationSequence) or a new one with capacity 1.

containsPlaneOrientationSequence

default boolean containsPlaneOrientationSequence()

Returns:

whether it contains the Plane Orientation Sequence (see PlaneOrientationSequence)

removePlaneOrientationSequence

default void removePlaneOrientationSequence()

Removes the Plane Orientation Sequence (see PlaneOrientationSequence