Package org.dcm4che.typeddicom.dataelements

Interface ReferencedFrameOfReferenceSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

StructureSetModule

All Known Implementing Classes:

ReferencedFrameOfReferenceSequence.SimpleHolder, RTDoseIOD, RTStructureSetIOD

Enclosing class:

ReferencedFrameOfReferenceSequence

public static interface ReferencedFrameOfReferenceSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Frame of Reference Sequence" (see ReferencedFrameOfReferenceSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedFrameOfReferenceSequence.Holder.Builder	builder()
static ReferencedFrameOfReferenceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedFrameOfReferenceSequence()
default ReferencedFrameOfReferenceSequence	ensureReferencedFrameOfReferenceSequence()	Adds a new Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence) with initial capacity 1 (see ensureReferencedFrameOfReferenceSequence(int)) if it does not already exist.
default ReferencedFrameOfReferenceSequence	ensureReferencedFrameOfReferenceSequence(int initialCapacity)	Adds a new Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence) if it does not already exist.
default ReferencedFrameOfReferenceSequence	getReferencedFrameOfReferenceSequence()
default ReferencedFrameOfReferenceSequence	newReferencedFrameOfReferenceSequence(int initialCapacity)	Adds a new Referenced Frame of Reference Sequence.
default void	removeReferencedFrameOfReferenceSequence()	Removes the Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence
static ReferencedFrameOfReferenceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence)

Returns:

A wrapper object implementing the ReferencedFrameOfReferenceSequence.Holder interface.

builder

static ReferencedFrameOfReferenceSequence.Holder.Builder builder()

Returns:

a ReferencedFrameOfReferenceSequence.Holder.Builder to create Referenced Frame of Reference Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ReferencedFrameOfReferenceSequence.Holder.Builder to create Referenced Frame of Reference Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getReferencedFrameOfReferenceSequence

default ReferencedFrameOfReferenceSequence getReferencedFrameOfReferenceSequence()

Returns:

the Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence)

newReferencedFrameOfReferenceSequence

default ReferencedFrameOfReferenceSequence newReferencedFrameOfReferenceSequence(int initialCapacity)

Adds a new Referenced Frame of Reference Sequence. (see ReferencedFrameOfReferenceSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Frame of Reference Sequence

ensureReferencedFrameOfReferenceSequence

default ReferencedFrameOfReferenceSequence ensureReferencedFrameOfReferenceSequence(int initialCapacity)

Adds a new Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new Referenced Frame of Reference Sequence is created.

Returns:

Either the already existing Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence) or a new one with capacity initialCapacity.

ensureReferencedFrameOfReferenceSequence

default ReferencedFrameOfReferenceSequence ensureReferencedFrameOfReferenceSequence()

Adds a new Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence) with initial capacity 1 (see ensureReferencedFrameOfReferenceSequence(int)) if it does not already exist.

Returns:

Either the already existing Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence) or a new one with capacity 1.

containsReferencedFrameOfReferenceSequence

default boolean containsReferencedFrameOfReferenceSequence()

Returns:

Whether it contains the Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence)

removeReferencedFrameOfReferenceSequence

default void removeReferencedFrameOfReferenceSequence()

Removes the Referenced Frame of Reference Sequence (see ReferencedFrameOfReferenceSequence