Package org.dcm4che.typeddicom.dataelements

Interface ReferencedPatientSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

PatientModule, PerformedProcedureStepRelationshipModule, VisitRelationshipModule

All Known Implementing Classes:

AcquisitionContextSRIOD, AdvancedBlendingPresentationStateIOD, AmbulatoryECGIOD, ArterialPulseWaveformIOD, AutorefractionMeasurementsIOD, BasicCardiacElectrophysiologyWaveformIOD, BasicStructuredDisplayIOD, BasicTextSRIOD, BasicVoiceAudioWaveformIOD, BlendingSoftcopyPresentationStateIOD, BodyPositionWaveformIOD, BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, ChestCADSRIOD, ColonCADSRIOD, ColorSoftcopyPresentationStateIOD, Comprehensive3DSRIOD, ComprehensiveSRIOD, ContentAssessmentResultsIOD, CornealTopographyMapIOD, CRImageIOD, CTImageIOD, CTPerformedProcedureProtocolIOD, DeformableSpatialRegistrationIOD, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, ElectromyogramIOD, ElectrooculogramIOD, EncapsulatedCDAIOD, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedSRIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRayRadiationDoseStructuredReportIOD, EnhancedXRFImageIOD, ExtensibleSRIOD, GeneralAudioWaveformIOD, GeneralECGIOD, GrayscaleSoftcopyPresentationStateIOD, HemodynamicWaveformIOD, ImplantationPlanSRDocumentIOD, IntraocularLensCalculationsIOD, IntravascularOpticalCoherenceTomographyImageIOD, KeratometryMeasurementsIOD, KeyObjectSelectionDocumentIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, LensometryMeasurementsIOD, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, MicroscopyBulkSimpleAnnotationsIOD, ModalityPerformedProcedureStepIOD, MRImageIOD, MRSpectroscopyIOD, MultiChannelRespiratoryWaveformIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicAxialMeasurementsIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, OphthalmicTomographyImageIOD, OphthalmicVisualFieldStaticPerimetryMeasurementsIOD, ParametricMapIOD, PatientRadiationDoseStructuredReportIOD, PerformedImagingAgentAdministrationSRIOD, PETImageIOD, PlanarMPRVolumetricPresentationStateIOD, PlannedImagingAgentAdministrationSRIOD, ProcedureLogIOD, PseudoColorSoftcopyPresentationStateIOD, RadiopharmaceuticalRadiationDoseSRIOD, RawDataIOD, RealTimeAudioWaveformIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RealWorldValueMappingIOD, ReferencedPatientSequence.SimpleHolder, RenditionSelectionDocumentIOD, RespiratoryWaveformIOD, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RoutineScalpElectroencephalogramIOD, RTBeamsDeliveryInstructionIOD, RTBeamsTreatmentRecordIOD, RTBrachyApplicationSetupDeliveryInstructionIOD, RTBrachyTreatmentRecordIOD, RTDoseIOD, RTImageIOD, RTIonBeamsTreatmentRecordIOD, RTIonPlanIOD, RTPhysicianIntentIOD, RTPlanIOD, RTRadiationRecordSetIOD, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetIOD, RTSegmentAnnotationIOD, RTStructureSetIOD, RTTreatmentPreparationIOD, RTTreatmentSummaryRecordIOD, SecondaryCaptureImageIOD, SegmentationIOD, SimplifiedAdultEchoSRIOD, SleepElectroencephalogramIOD, SpatialFiducialsIOD, SpatialRegistrationIOD, SpectaclePrescriptionReportIOD, StereometricRelationshipIOD, SubjectiveRefractionMeasurementsIOD, SurfaceScanMeshIOD, SurfaceScanPointCloudIOD, SurfaceSegmentationIOD, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD, TractographyResultsIOD, TwelveLeadECGIOD, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VisualAcuityMeasurementsIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, VolumeRenderingVolumetricPresentationStateIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XAPerformedProcedureProtocolIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiationDoseSRIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

ReferencedPatientSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedPatientSequence.Holder.Builder	builder()
static ReferencedPatientSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedPatientSequence()
default ReferencedPatientSequence	ensureReferencedPatientSequence()	Adds a new Referenced Patient Sequence (see ReferencedPatientSequence) with initial capacity 1 (see ensureReferencedPatientSequence(int)) if it does not already exist.
default ReferencedPatientSequence	ensureReferencedPatientSequence(int initialCapacity)	Adds a new Referenced Patient Sequence (see ReferencedPatientSequence) if it does not already exist.
default ReferencedPatientSequence	getReferencedPatientSequence()
default ReferencedPatientSequence	newReferencedPatientSequence(int initialCapacity)	Adds a new Referenced Patient Sequence.
default void	removeReferencedPatientSequence()	Removes the Referenced Patient Sequence (see ReferencedPatientSequence
static ReferencedPatientSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Patient Sequence (see ReferencedPatientSequence)

Returns:

a wrapper object implementing the ReferencedPatientSequence.Holder interface.

builder

static ReferencedPatientSequence.Holder.Builder builder()

Returns:

a ReferencedPatientSequence.Holder.Builder to create Referenced Patient Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedPatientSequence

default ReferencedPatientSequence getReferencedPatientSequence()

Returns:

the Referenced Patient Sequence (see ReferencedPatientSequence)

newReferencedPatientSequence

default ReferencedPatientSequence newReferencedPatientSequence(int initialCapacity)

Adds a new Referenced Patient Sequence. (see ReferencedPatientSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Patient Sequence

Returns:

the newly created ReferencedPatientSequence.

ensureReferencedPatientSequence

default ReferencedPatientSequence ensureReferencedPatientSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureReferencedPatientSequence

default ReferencedPatientSequence ensureReferencedPatientSequence()

Adds a new Referenced Patient Sequence (see ReferencedPatientSequence) with initial capacity 1 (see ensureReferencedPatientSequence(int)) if it does not already exist.

Returns:

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

containsReferencedPatientSequence

default boolean containsReferencedPatientSequence()

Returns:

whether it contains the Referenced Patient Sequence (see ReferencedPatientSequence)

removeReferencedPatientSequence

default void removeReferencedPatientSequence()

Removes the Referenced Patient Sequence (see ReferencedPatientSequence