Package org.dcm4che.typeddicom.dataelements

Interface ROIDescription.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

ROIDescription.SimpleHolder, StructureSetROISequence.Item

Enclosing class:

ROIDescription

public static interface ROIDescription.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "ROI Description" (see ROIDescription)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ROIDescription.Holder.Builder	builder()
static ROIDescription.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsROIDescription()
default ROIDescription	getROIDescription()
default void	removeROIDescription()	Removes the ROI Description (see ROIDescription
static ROIDescription.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the ROI Description (see ROIDescription)

Returns:

A wrapper object implementing the ROIDescription.Holder interface.

builder

static ROIDescription.Holder.Builder builder()

Returns:

a ROIDescription.Holder.Builder to create ROI Description Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ROIDescription.Holder.Builder to create ROI Description Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getROIDescription

default ROIDescription getROIDescription()

Returns:

the ROI Description (see ROIDescription)

containsROIDescription

default boolean containsROIDescription()

Returns:

Whether it contains the ROI Description (see ROIDescription)

removeROIDescription

default void removeROIDescription()

Removes the ROI Description (see ROIDescription