Package org.dcm4che.typeddicom.dataelements

Interface ReferencedSOPSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MediaCreationManagementModule, SRDocumentContentModule, StorageCommitmentModule

All Known Implementing Classes:

AcquisitionContextSequence.Item, AcquisitionContextSRIOD, AlternateValueSequence.Item, AnteriorChamberDepthSequence.Item, BasicTextSRIOD, ChestCADSRIOD, ColonCADSRIOD, Comprehensive3DSRIOD, ComprehensiveSRIOD, ContentItemModifierSequence.Item, ContentSequence.Item, CornealSizeSequence.Item, CorneaMeasurementsSequence.Item, DataObservationSequence.Item, DirectSegmentReferenceSequence.Item, DosimetricObjectiveParameterSequence.Item, EnhancedSRIOD, EnhancedXRayRadiationDoseStructuredReportIOD, ExtensibleSRIOD, ImplantationPlanSRDocumentIOD, InputInformationSequence.Item, KeyObjectSelectionDocumentIOD, LensThicknessSequence.Item, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, MediaCreationManagementIOD, MediaCreationManagementModule.SimpleWrapper, OphthalmicAxialLengthSequence.Item, OutputInformationSequence.Item, PatientRadiationDoseStructuredReportIOD, PatientSupportPositionParameterSequence.Item, PatientSupportPositionToleranceSequence.Item, PatientTreatmentPreparationProcedureParameterSequence.Item, PerformedImagingAgentAdministrationSRIOD, PerformedProcessingParametersSequence.Item, PlannedImagingAgentAdministrationSRIOD, PrescriptionNotesSequence.Item, ProcedureLogIOD, ProcedureStepProgressParametersSequence.Item, ProductParameterSequence.Item, ProtocolContextSequence.Item, QuantityDefinitionSequence.Item, RadiationDeviceConfigurationAndCommissioningKeySequence.Item, RadiopharmaceuticalRadiationDoseSRIOD, ReferencedPatientPhotoSequence.Item, ReferencedSeriesSequence.Item, RenditionSelectionDocumentIOD, ScheduledProcessingParametersSequence.Item, SegmentCharacteristicsSequence.Item, SimplifiedAdultEchoSRIOD, SourceOfRefractiveMeasurementsSequence.Item, SpecimenLocalizationContentItemSequence.Item, SpecimenPreparationStepContentItemSequence.Item, SpectaclePrescriptionReportIOD, SRDocumentContentModule.SimpleWrapper, StorageCommitmentIOD, StorageCommitmentModule.SimpleWrapper, SubstanceAdministrationParameterSequence.Item, XRayRadiationDoseSRIOD

Enclosing class:

ReferencedSOPSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced SOP Sequence" (see ReferencedSOPSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedSOPSequence.Holder.Builder	builder()
static ReferencedSOPSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedSOPSequence()
default ReferencedSOPSequence	ensureReferencedSOPSequence()	Adds a new Referenced SOP Sequence (see ReferencedSOPSequence) with initial capacity 1 (see ensureReferencedSOPSequence(int)) if it does not already exist.
default ReferencedSOPSequence	ensureReferencedSOPSequence(int initialCapacity)	Adds a new Referenced SOP Sequence (see ReferencedSOPSequence) if it does not already exist.
default ReferencedSOPSequence	getReferencedSOPSequence()
default ReferencedSOPSequence	newReferencedSOPSequence(int initialCapacity)	Adds a new Referenced SOP Sequence.
default void	removeReferencedSOPSequence()	Removes the Referenced SOP Sequence (see ReferencedSOPSequence
static ReferencedSOPSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced SOP Sequence (see ReferencedSOPSequence)

Returns:

a wrapper object implementing the ReferencedSOPSequence.Holder interface.

builder

static ReferencedSOPSequence.Holder.Builder builder()

Returns:

a ReferencedSOPSequence.Holder.Builder to create Referenced SOP Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedSOPSequence

default ReferencedSOPSequence getReferencedSOPSequence()

Returns:

the Referenced SOP Sequence (see ReferencedSOPSequence)

newReferencedSOPSequence

default ReferencedSOPSequence newReferencedSOPSequence(int initialCapacity)

Adds a new Referenced SOP Sequence. (see ReferencedSOPSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced SOP Sequence

Returns:

the newly created ReferencedSOPSequence.

ensureReferencedSOPSequence

default ReferencedSOPSequence ensureReferencedSOPSequence(int initialCapacity)

Adds a new Referenced SOP Sequence (see ReferencedSOPSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced SOP Sequence (see ReferencedSOPSequence) or a new one with capacity initialCapacity.

ensureReferencedSOPSequence

default ReferencedSOPSequence ensureReferencedSOPSequence()

Adds a new Referenced SOP Sequence (see ReferencedSOPSequence) with initial capacity 1 (see ensureReferencedSOPSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced SOP Sequence (see ReferencedSOPSequence) or a new one with capacity 1.

containsReferencedSOPSequence

default boolean containsReferencedSOPSequence()

Returns:

whether it contains the Referenced SOP Sequence (see ReferencedSOPSequence)

removeReferencedSOPSequence

default void removeReferencedSOPSequence()

Removes the Referenced SOP Sequence (see ReferencedSOPSequence