Package org.dcm4che.typeddicom.dataelements

Interface DocumentTitle.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

EncapsulatedDocumentModule

All Known Implementing Classes:

DocumentTitle.SimpleHolder, EncapsulatedCDAIOD, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, PertinentDocumentsSequence.Item

Enclosing class:

DocumentTitle

public static interface DocumentTitle.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DocumentTitle.Holder.Builder	builder()
static DocumentTitle.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDocumentTitle()
default DocumentTitle	getDocumentTitle()
default void	removeDocumentTitle()	Removes the Document Title (see DocumentTitle
static DocumentTitle.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Document Title (see DocumentTitle)

Returns:

A wrapper object implementing the DocumentTitle.Holder interface.

builder

static DocumentTitle.Holder.Builder builder()

Returns:

a DocumentTitle.Holder.Builder to create Document Title Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDocumentTitle

default DocumentTitle getDocumentTitle()

Returns:

the Document Title (see DocumentTitle)

containsDocumentTitle

default boolean containsDocumentTitle()

Returns:

Whether it contains the Document Title (see DocumentTitle)

removeDocumentTitle

default void removeDocumentTitle()

Removes the Document Title (see DocumentTitle