Package org.dcm4che.typeddicom.dataelements

Interface ROIPhysicalPropertiesSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

RTROIObservationsSequence.Item

Enclosing class:

ROIPhysicalPropertiesSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "ROI Physical Properties Sequence" (see ROIPhysicalPropertiesSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ROIPhysicalPropertiesSequence.Holder.Builder	builder()
static ROIPhysicalPropertiesSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsROIPhysicalPropertiesSequence()
default ROIPhysicalPropertiesSequence	ensureROIPhysicalPropertiesSequence()	Adds a new ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence) with initial capacity 1 (see ensureROIPhysicalPropertiesSequence(int)) if it does not already exist.
default ROIPhysicalPropertiesSequence	ensureROIPhysicalPropertiesSequence(int initialCapacity)	Adds a new ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence) if it does not already exist.
default ROIPhysicalPropertiesSequence	getROIPhysicalPropertiesSequence()
default ROIPhysicalPropertiesSequence	newROIPhysicalPropertiesSequence(int initialCapacity)	Adds a new ROI Physical Properties Sequence.
default void	removeROIPhysicalPropertiesSequence()	Removes the ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence
static ROIPhysicalPropertiesSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence)

Returns:

a wrapper object implementing the ROIPhysicalPropertiesSequence.Holder interface.

builder

static ROIPhysicalPropertiesSequence.Holder.Builder builder()

Returns:

a ROIPhysicalPropertiesSequence.Holder.Builder to create ROI Physical Properties Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ROIPhysicalPropertiesSequence.Holder.Builder to create ROI Physical Properties Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getROIPhysicalPropertiesSequence

default ROIPhysicalPropertiesSequence getROIPhysicalPropertiesSequence()

Returns:

the ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence)

newROIPhysicalPropertiesSequence

default ROIPhysicalPropertiesSequence newROIPhysicalPropertiesSequence(int initialCapacity)

Adds a new ROI Physical Properties Sequence. (see ROIPhysicalPropertiesSequence)

Parameters:

initialCapacity - the initial capacity for the new ROI Physical Properties Sequence

Returns:

the newly created ROIPhysicalPropertiesSequence.

ensureROIPhysicalPropertiesSequence

default ROIPhysicalPropertiesSequence ensureROIPhysicalPropertiesSequence(int initialCapacity)

Adds a new ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new ROI Physical Properties Sequence is created.

Returns:

either the already existing ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence) or a new one with capacity initialCapacity.

ensureROIPhysicalPropertiesSequence

default ROIPhysicalPropertiesSequence ensureROIPhysicalPropertiesSequence()

Adds a new ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence) with initial capacity 1 (see ensureROIPhysicalPropertiesSequence(int)) if it does not already exist.

Returns:

either the already existing ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence) or a new one with capacity 1.

containsROIPhysicalPropertiesSequence

default boolean containsROIPhysicalPropertiesSequence()

Returns:

whether it contains the ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence)

removeROIPhysicalPropertiesSequence

default void removeROIPhysicalPropertiesSequence()

Removes the ROI Physical Properties Sequence (see ROIPhysicalPropertiesSequence