Package org.dcm4che.typeddicom.dataelements

Interface FrameOfReferenceRelationshipSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

Enclosing class:

FrameOfReferenceRelationshipSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FrameOfReferenceRelationshipSequence.Holder.Builder	builder()
static FrameOfReferenceRelationshipSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFrameOfReferenceRelationshipSequence()
default FrameOfReferenceRelationshipSequence	ensureFrameOfReferenceRelationshipSequence()	Adds a new Frame of Reference Relationship Sequence (see FrameOfReferenceRelationshipSequence) with initial capacity 1 (see ensureFrameOfReferenceRelationshipSequence(int)) if it does not already exist.
default FrameOfReferenceRelationshipSequence	ensureFrameOfReferenceRelationshipSequence(int initialCapacity)	Adds a new Frame of Reference Relationship Sequence (see FrameOfReferenceRelationshipSequence) if it does not already exist.
default FrameOfReferenceRelationshipSequence	getFrameOfReferenceRelationshipSequence()
default FrameOfReferenceRelationshipSequence	newFrameOfReferenceRelationshipSequence(int initialCapacity)	Adds a new Frame of Reference Relationship Sequence.
default void	removeFrameOfReferenceRelationshipSequence()	Removes the Frame of Reference Relationship Sequence (see FrameOfReferenceRelationshipSequence
static FrameOfReferenceRelationshipSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Frame of Reference Relationship Sequence (see FrameOfReferenceRelationshipSequence)

Returns:

a wrapper object implementing the FrameOfReferenceRelationshipSequence.Holder interface.

builder

static FrameOfReferenceRelationshipSequence.Holder.Builder builder()

Returns:

a FrameOfReferenceRelationshipSequence.Holder.Builder to create Frame of Reference Relationship Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFrameOfReferenceRelationshipSequence

default FrameOfReferenceRelationshipSequence getFrameOfReferenceRelationshipSequence()

Returns:

the Frame of Reference Relationship Sequence (see FrameOfReferenceRelationshipSequence)

newFrameOfReferenceRelationshipSequence

default FrameOfReferenceRelationshipSequence newFrameOfReferenceRelationshipSequence(int initialCapacity)

Adds a new Frame of Reference Relationship Sequence. (see FrameOfReferenceRelationshipSequence)

Parameters:

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

Returns:

the newly created FrameOfReferenceRelationshipSequence.

ensureFrameOfReferenceRelationshipSequence

default FrameOfReferenceRelationshipSequence ensureFrameOfReferenceRelationshipSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing Frame of Reference Relationship Sequence (see FrameOfReferenceRelationshipSequence) or a new one with capacity initialCapacity.

ensureFrameOfReferenceRelationshipSequence

default FrameOfReferenceRelationshipSequence ensureFrameOfReferenceRelationshipSequence()

Adds a new Frame of Reference Relationship Sequence (see FrameOfReferenceRelationshipSequence) with initial capacity 1 (see ensureFrameOfReferenceRelationshipSequence(int)) if it does not already exist.

Returns:

either the already existing Frame of Reference Relationship Sequence (see FrameOfReferenceRelationshipSequence) or a new one with capacity 1.

containsFrameOfReferenceRelationshipSequence

default boolean containsFrameOfReferenceRelationshipSequence()

Returns:

whether it contains the Frame of Reference Relationship Sequence (see FrameOfReferenceRelationshipSequence)

removeFrameOfReferenceRelationshipSequence

default void removeFrameOfReferenceRelationshipSequence()

Removes the Frame of Reference Relationship Sequence (see FrameOfReferenceRelationshipSequence