Package org.dcm4che.typeddicom.dataelements

Interface EncapsulatedDocument.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

EncapsulatedDocumentModule, ImplantAssemblyTemplateModule

All Known Implementing Classes:

EncapsulatedCDAIOD, EncapsulatedDocument.SimpleHolder, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, ImplantAssemblyTemplateIOD, InformationFromManufacturerSequence.Item, NotificationFromManufacturerSequence.Item

Enclosing class:

EncapsulatedDocument

public static interface EncapsulatedDocument.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Encapsulated Document" (see EncapsulatedDocument)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EncapsulatedDocument.Holder.Builder	builder()
static EncapsulatedDocument.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsEncapsulatedDocument()
default EncapsulatedDocument	getEncapsulatedDocument()
default void	removeEncapsulatedDocument()	Removes the Encapsulated Document (see EncapsulatedDocument
static EncapsulatedDocument.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Encapsulated Document (see EncapsulatedDocument)

Returns:

A wrapper object implementing the EncapsulatedDocument.Holder interface.

builder

static EncapsulatedDocument.Holder.Builder builder()

Returns:

a EncapsulatedDocument.Holder.Builder to create Encapsulated Document Items with a fluent API.

builder

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

Parameters:

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

Returns:

a EncapsulatedDocument.Holder.Builder to create Encapsulated Document Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getEncapsulatedDocument

default EncapsulatedDocument getEncapsulatedDocument()

Returns:

the Encapsulated Document (see EncapsulatedDocument)

containsEncapsulatedDocument

default boolean containsEncapsulatedDocument()

Returns:

Whether it contains the Encapsulated Document (see EncapsulatedDocument)

removeEncapsulatedDocument

default void removeEncapsulatedDocument()

Removes the Encapsulated Document (see EncapsulatedDocument