Package org.dcm4che.typeddicom.dataelements

Interface ReferenceBasisCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

AcquisitionEndLocationSequence.Item, AcquisitionStartLocationSequence.Item, PositioningLandmarkSequence.Item, ReconstructionEndLocationSequence.Item, ReconstructionStartLocationSequence.Item, ReconstructionTargetCenterLocationSequence.Item

Enclosing class:

ReferenceBasisCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Reference Basis Code Sequence" (see ReferenceBasisCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferenceBasisCodeSequence.Holder.Builder	builder()
static ReferenceBasisCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferenceBasisCodeSequence()
default ReferenceBasisCodeSequence	ensureReferenceBasisCodeSequence()	Adds a new Reference Basis Code Sequence (see ReferenceBasisCodeSequence) with initial capacity 1 (see ensureReferenceBasisCodeSequence(int)) if it does not already exist.
default ReferenceBasisCodeSequence	ensureReferenceBasisCodeSequence(int initialCapacity)	Adds a new Reference Basis Code Sequence (see ReferenceBasisCodeSequence) if it does not already exist.
default ReferenceBasisCodeSequence	getReferenceBasisCodeSequence()
default ReferenceBasisCodeSequence	newReferenceBasisCodeSequence(int initialCapacity)	Adds a new Reference Basis Code Sequence.
default void	removeReferenceBasisCodeSequence()	Removes the Reference Basis Code Sequence (see ReferenceBasisCodeSequence
static ReferenceBasisCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Reference Basis Code Sequence (see ReferenceBasisCodeSequence)

Returns:

a wrapper object implementing the ReferenceBasisCodeSequence.Holder interface.

builder

static ReferenceBasisCodeSequence.Holder.Builder builder()

Returns:

a ReferenceBasisCodeSequence.Holder.Builder to create Reference Basis Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ReferenceBasisCodeSequence.Holder.Builder to create Reference Basis Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getReferenceBasisCodeSequence

default ReferenceBasisCodeSequence getReferenceBasisCodeSequence()

Returns:

the Reference Basis Code Sequence (see ReferenceBasisCodeSequence)

newReferenceBasisCodeSequence

default ReferenceBasisCodeSequence newReferenceBasisCodeSequence(int initialCapacity)

Adds a new Reference Basis Code Sequence. (see ReferenceBasisCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Reference Basis Code Sequence

Returns:

the newly created ReferenceBasisCodeSequence.

ensureReferenceBasisCodeSequence

default ReferenceBasisCodeSequence ensureReferenceBasisCodeSequence(int initialCapacity)

Adds a new Reference Basis Code Sequence (see ReferenceBasisCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Reference Basis Code Sequence (see ReferenceBasisCodeSequence) or a new one with capacity initialCapacity.

ensureReferenceBasisCodeSequence

default ReferenceBasisCodeSequence ensureReferenceBasisCodeSequence()

Adds a new Reference Basis Code Sequence (see ReferenceBasisCodeSequence) with initial capacity 1 (see ensureReferenceBasisCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Reference Basis Code Sequence (see ReferenceBasisCodeSequence) or a new one with capacity 1.

containsReferenceBasisCodeSequence

default boolean containsReferenceBasisCodeSequence()

Returns:

whether it contains the Reference Basis Code Sequence (see ReferenceBasisCodeSequence)

removeReferenceBasisCodeSequence

default void removeReferenceBasisCodeSequence()

Removes the Reference Basis Code Sequence (see ReferenceBasisCodeSequence