Package org.dcm4che.typeddicom.dataelements

Interface IdenticalDocumentsSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

EncapsulatedDocumentModule, KeyObjectDocumentModule, SRDocumentGeneralModule

All Known Implementing Classes:

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

Enclosing class:

IdenticalDocumentsSequence

public static interface IdenticalDocumentsSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Identical Documents Sequence" (see IdenticalDocumentsSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IdenticalDocumentsSequence.Holder.Builder	builder()
static IdenticalDocumentsSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsIdenticalDocumentsSequence()
default IdenticalDocumentsSequence	ensureIdenticalDocumentsSequence()	Adds a new Identical Documents Sequence (see IdenticalDocumentsSequence) with initial capacity 1 (see ensureIdenticalDocumentsSequence(int)) if it does not already exist.
default IdenticalDocumentsSequence	ensureIdenticalDocumentsSequence(int initialCapacity)	Adds a new Identical Documents Sequence (see IdenticalDocumentsSequence) if it does not already exist.
default IdenticalDocumentsSequence	getIdenticalDocumentsSequence()
default IdenticalDocumentsSequence	newIdenticalDocumentsSequence(int initialCapacity)	Adds a new Identical Documents Sequence.
default void	removeIdenticalDocumentsSequence()	Removes the Identical Documents Sequence (see IdenticalDocumentsSequence
static IdenticalDocumentsSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Identical Documents Sequence (see IdenticalDocumentsSequence)

Returns:

A wrapper object implementing the IdenticalDocumentsSequence.Holder interface.

builder

static IdenticalDocumentsSequence.Holder.Builder builder()

Returns:

a IdenticalDocumentsSequence.Holder.Builder to create Identical Documents Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getIdenticalDocumentsSequence

default IdenticalDocumentsSequence getIdenticalDocumentsSequence()

Returns:

the Identical Documents Sequence (see IdenticalDocumentsSequence)

newIdenticalDocumentsSequence

default IdenticalDocumentsSequence newIdenticalDocumentsSequence(int initialCapacity)

Adds a new Identical Documents Sequence. (see IdenticalDocumentsSequence)

Parameters:

initialCapacity - the initial capacity for the new Identical Documents Sequence

ensureIdenticalDocumentsSequence

default IdenticalDocumentsSequence ensureIdenticalDocumentsSequence(int initialCapacity)

Adds a new Identical Documents Sequence (see IdenticalDocumentsSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new Identical Documents Sequence is created.

Returns:

Either the already existing Identical Documents Sequence (see IdenticalDocumentsSequence) or a new one with capacity initialCapacity.

ensureIdenticalDocumentsSequence

default IdenticalDocumentsSequence ensureIdenticalDocumentsSequence()

Adds a new Identical Documents Sequence (see IdenticalDocumentsSequence) with initial capacity 1 (see ensureIdenticalDocumentsSequence(int)) if it does not already exist.

Returns:

Either the already existing Identical Documents Sequence (see IdenticalDocumentsSequence) or a new one with capacity 1.

containsIdenticalDocumentsSequence

default boolean containsIdenticalDocumentsSequence()

Returns:

Whether it contains the Identical Documents Sequence (see IdenticalDocumentsSequence)

removeIdenticalDocumentsSequence

default void removeIdenticalDocumentsSequence()

Removes the Identical Documents Sequence (see IdenticalDocumentsSequence