Package org.dcm4che.typeddicom.dataelements

Interface EntityDescription.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

RTTreatmentPreparationModule

All Known Implementing Classes:

EntityDescription.SimpleHolder, IntendedRTTreatmentPhaseSequence.Item, RTAnatomicPrescriptionSequence.Item, RTSegmentAnnotationSequence.Item, RTTreatmentPreparationIOD

Enclosing class:

EntityDescription

public static interface EntityDescription.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EntityDescription.Holder.Builder	builder()
static EntityDescription.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsEntityDescription()
default EntityDescription	getEntityDescription()
default void	removeEntityDescription()	Removes the Entity Description (see EntityDescription
static EntityDescription.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Entity Description (see EntityDescription)

Returns:

A wrapper object implementing the EntityDescription.Holder interface.

builder

static EntityDescription.Holder.Builder builder()

Returns:

a EntityDescription.Holder.Builder to create Entity Description Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getEntityDescription

default EntityDescription getEntityDescription()

Returns:

the Entity Description (see EntityDescription)

containsEntityDescription

default boolean containsEntityDescription()

Returns:

Whether it contains the Entity Description (see EntityDescription)

removeEntityDescription

default void removeEntityDescription()

Removes the Entity Description (see EntityDescription