Package org.dcm4che.typeddicom.dataelements

Interface ContentSequence.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, KeyObjectSelectionDocumentIOD, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, PatientRadiationDoseStructuredReportIOD, PerformedImagingAgentAdministrationSRIOD, PlannedImagingAgentAdministrationSRIOD, ProcedureLogIOD, RadiopharmaceuticalRadiationDoseSRIOD, RenditionSelectionDocumentIOD, SimplifiedAdultEchoSRIOD, SpectaclePrescriptionReportIOD, SRDocumentContentModule.SimpleWrapper, XRayRadiationDoseSRIOD

Enclosing class:

ContentSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContentSequence.Holder.Builder	builder()
static ContentSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsContentSequence()
default ContentSequence	ensureContentSequence()	Adds a new Content Sequence (see ContentSequence) with initial capacity 1 (see ensureContentSequence(int)) if it does not already exist.
default ContentSequence	ensureContentSequence(int initialCapacity)	Adds a new Content Sequence (see ContentSequence) if it does not already exist.
default ContentSequence	getContentSequence()
default ContentSequence	newContentSequence(int initialCapacity)	Adds a new Content Sequence.
default void	removeContentSequence()	Removes the Content Sequence (see ContentSequence
static ContentSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Content Sequence (see ContentSequence)

Returns:

a wrapper object implementing the ContentSequence.Holder interface.

builder

static ContentSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getContentSequence

default ContentSequence getContentSequence()

Returns:

the Content Sequence (see ContentSequence)

newContentSequence

default ContentSequence newContentSequence(int initialCapacity)

Adds a new Content Sequence. (see ContentSequence)

Parameters:

initialCapacity - the initial capacity for the new Content Sequence

Returns:

the newly created ContentSequence.

ensureContentSequence

default ContentSequence ensureContentSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureContentSequence

default ContentSequence ensureContentSequence()

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

Returns:

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

containsContentSequence

default boolean containsContentSequence()

Returns:

whether it contains the Content Sequence (see ContentSequence)

removeContentSequence

default void removeContentSequence()

Removes the Content Sequence (see ContentSequence