Package org.dcm4che.typeddicom.dataelements

Interface ContentTemplateSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

EncapsulatedDocumentModule, SRDocumentContentModule

All Known Implementing Classes:

AcquisitionContextSRIOD, BasicTextSRIOD, ChestCADSRIOD, ColonCADSRIOD, Comprehensive3DSRIOD, ComprehensiveSRIOD, ContentSequence.Item, EncapsulatedCDAIOD, EncapsulatedDocumentModule.SimpleWrapper, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, EnhancedSRIOD, EnhancedXRayRadiationDoseStructuredReportIOD, ExtensibleSRIOD, ImplantationPlanSRDocumentIOD, InventoriedInstancesSequence.Item, KeyObjectSelectionDocumentIOD, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, PatientRadiationDoseStructuredReportIOD, PerformedImagingAgentAdministrationSRIOD, PlannedImagingAgentAdministrationSRIOD, ProcedureLogIOD, RadiopharmaceuticalRadiationDoseSRIOD, RenditionSelectionDocumentIOD, SimplifiedAdultEchoSRIOD, SpectaclePrescriptionReportIOD, SRDocumentContentModule.SimpleWrapper, XRayRadiationDoseSRIOD

Enclosing class:

ContentTemplateSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Content Template Sequence" (see ContentTemplateSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContentTemplateSequence.Holder.Builder	builder()
static ContentTemplateSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsContentTemplateSequence()
default ContentTemplateSequence	ensureContentTemplateSequence()	Adds a new Content Template Sequence (see ContentTemplateSequence) with initial capacity 1 (see ensureContentTemplateSequence(int)) if it does not already exist.
default ContentTemplateSequence	ensureContentTemplateSequence(int initialCapacity)	Adds a new Content Template Sequence (see ContentTemplateSequence) if it does not already exist.
default ContentTemplateSequence	getContentTemplateSequence()
default ContentTemplateSequence	newContentTemplateSequence(int initialCapacity)	Adds a new Content Template Sequence.
default void	removeContentTemplateSequence()	Removes the Content Template Sequence (see ContentTemplateSequence
static ContentTemplateSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Content Template Sequence (see ContentTemplateSequence)

Returns:

a wrapper object implementing the ContentTemplateSequence.Holder interface.

builder

static ContentTemplateSequence.Holder.Builder builder()

Returns:

a ContentTemplateSequence.Holder.Builder to create Content Template Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ContentTemplateSequence.Holder.Builder to create Content Template Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getContentTemplateSequence

default ContentTemplateSequence getContentTemplateSequence()

Returns:

the Content Template Sequence (see ContentTemplateSequence)

newContentTemplateSequence

default ContentTemplateSequence newContentTemplateSequence(int initialCapacity)

Adds a new Content Template Sequence. (see ContentTemplateSequence)

Parameters:

initialCapacity - the initial capacity for the new Content Template Sequence

Returns:

the newly created ContentTemplateSequence.

ensureContentTemplateSequence

default ContentTemplateSequence ensureContentTemplateSequence(int initialCapacity)

Adds a new Content Template Sequence (see ContentTemplateSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Content Template Sequence is created.

Returns:

either the already existing Content Template Sequence (see ContentTemplateSequence) or a new one with capacity initialCapacity.

ensureContentTemplateSequence

default ContentTemplateSequence ensureContentTemplateSequence()

Adds a new Content Template Sequence (see ContentTemplateSequence) with initial capacity 1 (see ensureContentTemplateSequence(int)) if it does not already exist.

Returns:

either the already existing Content Template Sequence (see ContentTemplateSequence) or a new one with capacity 1.

containsContentTemplateSequence

default boolean containsContentTemplateSequence()

Returns:

whether it contains the Content Template Sequence (see ContentTemplateSequence)

removeContentTemplateSequence

default void removeContentTemplateSequence()

Removes the Content Template Sequence (see ContentTemplateSequence