Package org.dcm4che.typeddicom.dataelements

Interface ReferencedStructureSetSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

RTDVHModule, RTGeneralPlanModule

All Known Implementing Classes:

ReferencedStructureSetSequence.SimpleHolder, RTDoseIOD, RTIonPlanIOD, RTPlanIOD

Enclosing class:

ReferencedStructureSetSequence

public static interface ReferencedStructureSetSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Structure Set Sequence" (see ReferencedStructureSetSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedStructureSetSequence.Holder.Builder	builder()
static ReferencedStructureSetSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedStructureSetSequence()
default ReferencedStructureSetSequence	ensureReferencedStructureSetSequence()	Adds a new Referenced Structure Set Sequence (see ReferencedStructureSetSequence) with initial capacity 1 (see ensureReferencedStructureSetSequence(int)) if it does not already exist.
default ReferencedStructureSetSequence	ensureReferencedStructureSetSequence(int initialCapacity)	Adds a new Referenced Structure Set Sequence (see ReferencedStructureSetSequence) if it does not already exist.
default ReferencedStructureSetSequence	getReferencedStructureSetSequence()
default ReferencedStructureSetSequence	newReferencedStructureSetSequence(int initialCapacity)	Adds a new Referenced Structure Set Sequence.
default void	removeReferencedStructureSetSequence()	Removes the Referenced Structure Set Sequence (see ReferencedStructureSetSequence
static ReferencedStructureSetSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Referenced Structure Set Sequence (see ReferencedStructureSetSequence)

Returns:

A wrapper object implementing the ReferencedStructureSetSequence.Holder interface.

builder

static ReferencedStructureSetSequence.Holder.Builder builder()

Returns:

a ReferencedStructureSetSequence.Holder.Builder to create Referenced Structure Set Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ReferencedStructureSetSequence.Holder.Builder to create Referenced Structure Set Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getReferencedStructureSetSequence

default ReferencedStructureSetSequence getReferencedStructureSetSequence()

Returns:

the Referenced Structure Set Sequence (see ReferencedStructureSetSequence)

newReferencedStructureSetSequence

default ReferencedStructureSetSequence newReferencedStructureSetSequence(int initialCapacity)

Adds a new Referenced Structure Set Sequence. (see ReferencedStructureSetSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Structure Set Sequence

ensureReferencedStructureSetSequence

default ReferencedStructureSetSequence ensureReferencedStructureSetSequence(int initialCapacity)

Adds a new Referenced Structure Set Sequence (see ReferencedStructureSetSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new Referenced Structure Set Sequence is created.

Returns:

Either the already existing Referenced Structure Set Sequence (see ReferencedStructureSetSequence) or a new one with capacity initialCapacity.

ensureReferencedStructureSetSequence

default ReferencedStructureSetSequence ensureReferencedStructureSetSequence()

Adds a new Referenced Structure Set Sequence (see ReferencedStructureSetSequence) with initial capacity 1 (see ensureReferencedStructureSetSequence(int)) if it does not already exist.

Returns:

Either the already existing Referenced Structure Set Sequence (see ReferencedStructureSetSequence) or a new one with capacity 1.

containsReferencedStructureSetSequence

default boolean containsReferencedStructureSetSequence()

Returns:

Whether it contains the Referenced Structure Set Sequence (see ReferencedStructureSetSequence)

removeReferencedStructureSetSequence

default void removeReferencedStructureSetSequence()

Removes the Referenced Structure Set Sequence (see ReferencedStructureSetSequence