Package org.dcm4che.typeddicom.dataelements

Interface FractionBasedRelationshipSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

FractionBasedRelationshipSequence.SimpleHolder, RTPrescriptionSequence.Item

Enclosing class:

FractionBasedRelationshipSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Fraction-Based Relationship Sequence" (see FractionBasedRelationshipSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FractionBasedRelationshipSequence.Holder.Builder	builder()
static FractionBasedRelationshipSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFractionBasedRelationshipSequence()
default FractionBasedRelationshipSequence	ensureFractionBasedRelationshipSequence()	Adds a new Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence) with initial capacity 1 (see ensureFractionBasedRelationshipSequence(int)) if it does not already exist.
default FractionBasedRelationshipSequence	ensureFractionBasedRelationshipSequence(int initialCapacity)	Adds a new Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence) if it does not already exist.
default FractionBasedRelationshipSequence	getFractionBasedRelationshipSequence()
default FractionBasedRelationshipSequence	newFractionBasedRelationshipSequence(int initialCapacity)	Adds a new Fraction-Based Relationship Sequence.
default void	removeFractionBasedRelationshipSequence()	Removes the Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence
static FractionBasedRelationshipSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence)

Returns:

a wrapper object implementing the FractionBasedRelationshipSequence.Holder interface.

builder

static FractionBasedRelationshipSequence.Holder.Builder builder()

Returns:

a FractionBasedRelationshipSequence.Holder.Builder to create Fraction-Based Relationship Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a FractionBasedRelationshipSequence.Holder.Builder to create Fraction-Based Relationship Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getFractionBasedRelationshipSequence

default FractionBasedRelationshipSequence getFractionBasedRelationshipSequence()

Returns:

the Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence)

newFractionBasedRelationshipSequence

default FractionBasedRelationshipSequence newFractionBasedRelationshipSequence(int initialCapacity)

Adds a new Fraction-Based Relationship Sequence. (see FractionBasedRelationshipSequence)

Parameters:

initialCapacity - the initial capacity for the new Fraction-Based Relationship Sequence

Returns:

the newly created FractionBasedRelationshipSequence.

ensureFractionBasedRelationshipSequence

default FractionBasedRelationshipSequence ensureFractionBasedRelationshipSequence(int initialCapacity)

Adds a new Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence) or a new one with capacity initialCapacity.

ensureFractionBasedRelationshipSequence

default FractionBasedRelationshipSequence ensureFractionBasedRelationshipSequence()

Adds a new Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence) with initial capacity 1 (see ensureFractionBasedRelationshipSequence(int)) if it does not already exist.

Returns:

either the already existing Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence) or a new one with capacity 1.

containsFractionBasedRelationshipSequence

default boolean containsFractionBasedRelationshipSequence()

Returns:

whether it contains the Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence)

removeFractionBasedRelationshipSequence

default void removeFractionBasedRelationshipSequence()

Removes the Fraction-Based Relationship Sequence (see FractionBasedRelationshipSequence