Package org.dcm4che.typeddicom.dataelements

Interface PurposeOfReferenceCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

AlternateRepresentationSequence.Item, ContributingEquipmentSequence.Item, PertinentDocumentsSequence.Item, PlanningInputInformationSequence.Item, ReferencedImageSequence.Item, ReferencedInstanceSequence.Item, ReferencedSOPSequence.Item, RelatedSeriesSequence.Item, RTPhysicianIntentInputInstanceSequence.Item, SourceImageSequence.Item, SourceInstanceSequence.Item

Enclosing class:

PurposeOfReferenceCodeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PurposeOfReferenceCodeSequence.Holder.Builder	builder()
static PurposeOfReferenceCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPurposeOfReferenceCodeSequence()
default PurposeOfReferenceCodeSequence	ensurePurposeOfReferenceCodeSequence()	Adds a new Purpose of Reference Code Sequence (see PurposeOfReferenceCodeSequence) with initial capacity 1 (see ensurePurposeOfReferenceCodeSequence(int)) if it does not already exist.
default PurposeOfReferenceCodeSequence	ensurePurposeOfReferenceCodeSequence(int initialCapacity)	Adds a new Purpose of Reference Code Sequence (see PurposeOfReferenceCodeSequence) if it does not already exist.
default PurposeOfReferenceCodeSequence	getPurposeOfReferenceCodeSequence()
default PurposeOfReferenceCodeSequence	newPurposeOfReferenceCodeSequence(int initialCapacity)	Adds a new Purpose of Reference Code Sequence.
default void	removePurposeOfReferenceCodeSequence()	Removes the Purpose of Reference Code Sequence (see PurposeOfReferenceCodeSequence
static PurposeOfReferenceCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Purpose of Reference Code Sequence (see PurposeOfReferenceCodeSequence)

Returns:

a wrapper object implementing the PurposeOfReferenceCodeSequence.Holder interface.

builder

static PurposeOfReferenceCodeSequence.Holder.Builder builder()

Returns:

a PurposeOfReferenceCodeSequence.Holder.Builder to create Purpose of Reference Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPurposeOfReferenceCodeSequence

default PurposeOfReferenceCodeSequence getPurposeOfReferenceCodeSequence()

Returns:

the Purpose of Reference Code Sequence (see PurposeOfReferenceCodeSequence)

newPurposeOfReferenceCodeSequence

default PurposeOfReferenceCodeSequence newPurposeOfReferenceCodeSequence(int initialCapacity)

Adds a new Purpose of Reference Code Sequence. (see PurposeOfReferenceCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Purpose of Reference Code Sequence

Returns:

the newly created PurposeOfReferenceCodeSequence.

ensurePurposeOfReferenceCodeSequence

default PurposeOfReferenceCodeSequence ensurePurposeOfReferenceCodeSequence(int initialCapacity)

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

Parameters:

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

Returns:

either the already existing Purpose of Reference Code Sequence (see PurposeOfReferenceCodeSequence) or a new one with capacity initialCapacity.

ensurePurposeOfReferenceCodeSequence

default PurposeOfReferenceCodeSequence ensurePurposeOfReferenceCodeSequence()

Adds a new Purpose of Reference Code Sequence (see PurposeOfReferenceCodeSequence) with initial capacity 1 (see ensurePurposeOfReferenceCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Purpose of Reference Code Sequence (see PurposeOfReferenceCodeSequence) or a new one with capacity 1.

containsPurposeOfReferenceCodeSequence

default boolean containsPurposeOfReferenceCodeSequence()

Returns:

whether it contains the Purpose of Reference Code Sequence (see PurposeOfReferenceCodeSequence)

removePurposeOfReferenceCodeSequence

default void removePurposeOfReferenceCodeSequence()

Removes the Purpose of Reference Code Sequence (see PurposeOfReferenceCodeSequence