Package org.dcm4che.typeddicom.dataelements

Interface ReferencedInstanceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

EncapsulatedDocumentModule, EnhancedUSImageModule, EnhancedXAXRFImageModuleTable, GeneralReferenceModule, IntravascularOCTImageModule, MRSpectroscopyModule, OphthalmicThicknessMapModule, RawDataModule, RTDoseModule, SRDocumentGeneralModule, TractographyResultsModule, WaveformIdentificationModule

All Known Implementing Classes:

AcquisitionContextSRIOD, AmbulatoryECGIOD, ArterialPulseWaveformIOD, BasicCardiacElectrophysiologyWaveformIOD, BasicTextSRIOD, BasicVoiceAudioWaveformIOD, BodyPositionWaveformIOD, CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, ChestCADSRIOD, ColonCADSRIOD, Comprehensive3DSRIOD, ComprehensiveSRIOD, CornealTopographyMapIOD, CRImageIOD, CTImageIOD, DeformableSpatialRegistrationIOD, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, ElectromyogramIOD, ElectrooculogramIOD, EncapsulatedCDAIOD, EncapsulatedDocumentModule.SimpleWrapper, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, EnhancedSRIOD, EnhancedUSImageModule.SimpleWrapper, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXAXRFImageModuleTable.SimpleWrapper, EnhancedXRayRadiationDoseStructuredReportIOD, EnhancedXRFImageIOD, ExtensibleSRIOD, GeneralAudioWaveformIOD, GeneralECGIOD, GeneralReferenceModule.SimpleWrapper, HemodynamicWaveformIOD, ImplantationPlanSRDocumentIOD, IntravascularOCTImageModule.SimpleWrapper, IntravascularOpticalCoherenceTomographyImageIOD, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, MRImageIOD, MRSpectroscopyIOD, MRSpectroscopyModule.SimpleWrapper, MultiChannelRespiratoryWaveformIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, OphthalmicThicknessMapModule.SimpleWrapper, ParametricMapIOD, PatientRadiationDoseStructuredReportIOD, PerformedImagingAgentAdministrationSRIOD, PETImageIOD, PlannedImagingAgentAdministrationSRIOD, ProcedureLogIOD, RadiopharmaceuticalRadiationDoseSRIOD, RawDataIOD, RawDataModule.SimpleWrapper, RealTimeAudioWaveformIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, ReferencedSeriesSequence.Item, RespiratoryWaveformIOD, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RoutineScalpElectroencephalogramIOD, RTBeamsDeliveryInstructionIOD, RTBeamsTreatmentRecordIOD, RTBrachyApplicationSetupDeliveryInstructionIOD, RTBrachyTreatmentRecordIOD, RTDoseIOD, RTDoseModule.SimpleWrapper, RTImageIOD, RTIonBeamsTreatmentRecordIOD, RTIonPlanIOD, RTPhysicianIntentIOD, RTPlanIOD, RTRadiationRecordSetIOD, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetIOD, RTSegmentAnnotationIOD, RTStructureSetIOD, RTTreatmentPreparationIOD, RTTreatmentSummaryRecordIOD, SecondaryCaptureImageIOD, SegmentationIOD, SimplifiedAdultEchoSRIOD, SleepElectroencephalogramIOD, SpatialFiducialsIOD, SpatialRegistrationIOD, SpectaclePrescriptionReportIOD, SRDocumentGeneralModule.SimpleWrapper, StructuredDisplayImageBoxSequence.Item, SurfaceSegmentationIOD, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD, TractographyResultsIOD, TractographyResultsModule.SimpleWrapper, TwelveLeadECGIOD, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, WaveformIdentificationModule.SimpleWrapper, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XRayAngiographicImageIOD, XRayRadiationDoseSRIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

ReferencedInstanceSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedInstanceSequence.Holder.Builder	builder()
static ReferencedInstanceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedInstanceSequence()
default ReferencedInstanceSequence	ensureReferencedInstanceSequence()	Adds a new Referenced Instance Sequence (see ReferencedInstanceSequence) with initial capacity 1 (see ensureReferencedInstanceSequence(int)) if it does not already exist.
default ReferencedInstanceSequence	ensureReferencedInstanceSequence(int initialCapacity)	Adds a new Referenced Instance Sequence (see ReferencedInstanceSequence) if it does not already exist.
default ReferencedInstanceSequence	getReferencedInstanceSequence()
default ReferencedInstanceSequence	newReferencedInstanceSequence(int initialCapacity)	Adds a new Referenced Instance Sequence.
default void	removeReferencedInstanceSequence()	Removes the Referenced Instance Sequence (see ReferencedInstanceSequence
static ReferencedInstanceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Instance Sequence (see ReferencedInstanceSequence)

Returns:

a wrapper object implementing the ReferencedInstanceSequence.Holder interface.

builder

static ReferencedInstanceSequence.Holder.Builder builder()

Returns:

a ReferencedInstanceSequence.Holder.Builder to create Referenced Instance Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedInstanceSequence

default ReferencedInstanceSequence getReferencedInstanceSequence()

Returns:

the Referenced Instance Sequence (see ReferencedInstanceSequence)

newReferencedInstanceSequence

default ReferencedInstanceSequence newReferencedInstanceSequence(int initialCapacity)

Adds a new Referenced Instance Sequence. (see ReferencedInstanceSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Instance Sequence

Returns:

the newly created ReferencedInstanceSequence.

ensureReferencedInstanceSequence

default ReferencedInstanceSequence ensureReferencedInstanceSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureReferencedInstanceSequence

default ReferencedInstanceSequence ensureReferencedInstanceSequence()

Adds a new Referenced Instance Sequence (see ReferencedInstanceSequence) with initial capacity 1 (see ensureReferencedInstanceSequence(int)) if it does not already exist.

Returns:

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

containsReferencedInstanceSequence

default boolean containsReferencedInstanceSequence()

Returns:

whether it contains the Referenced Instance Sequence (see ReferencedInstanceSequence)

removeReferencedInstanceSequence

default void removeReferencedInstanceSequence()

Removes the Referenced Instance Sequence (see ReferencedInstanceSequence