Package org.dcm4che.typeddicom.dataelements

Interface ReferencedStudySequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

GeneralStudyModule, PatientRelationshipModule, RequestedProcedureModule, 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, GeneralStudyModule.SimpleWrapper, GrayscaleSoftcopyPresentationStateIOD, HemodynamicWaveformIOD, ImplantationPlanSRDocumentIOD, IntraocularLensCalculationsIOD, IntravascularOpticalCoherenceTomographyImageIOD, KeratometryMeasurementsIOD, KeyObjectSelectionDocumentIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, LensometryMeasurementsIOD, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, MicroscopyBulkSimpleAnnotationsIOD, MRImageIOD, MRSpectroscopyIOD, MultiChannelRespiratoryWaveformIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicAxialMeasurementsIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, OphthalmicTomographyImageIOD, OphthalmicVisualFieldStaticPerimetryMeasurementsIOD, ParametricMapIOD, PatientRadiationDoseStructuredReportIOD, PatientRelationshipModule.SimpleWrapper, PerformedImagingAgentAdministrationSRIOD, PETImageIOD, PlanarMPRVolumetricPresentationStateIOD, PlannedImagingAgentAdministrationSRIOD, PlanningInputInformationSequence.Item, ProcedureLogIOD, PseudoColorSoftcopyPresentationStateIOD, RadiopharmaceuticalRadiationDoseSRIOD, RawDataIOD, RealTimeAudioWaveformIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RealWorldValueMappingIOD, ReferencedRequestSequence.Item, RenditionSelectionDocumentIOD, RequestAttributesSequence.Item, RequestedProcedureModule.SimpleWrapper, RespiratoryWaveformIOD, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RoutineScalpElectroencephalogramIOD, RTBeamsDeliveryInstructionIOD, RTBeamsTreatmentRecordIOD, RTBrachyApplicationSetupDeliveryInstructionIOD, RTBrachyTreatmentRecordIOD, RTDoseIOD, RTImageIOD, RTIonBeamsTreatmentRecordIOD, RTIonPlanIOD, RTPhysicianIntentInputInstanceSequence.Item, RTPhysicianIntentIOD, RTPlanIOD, RTRadiationRecordSetIOD, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetIOD, RTSegmentAnnotationIOD, RTStructureSetIOD, RTTreatmentPreparationIOD, RTTreatmentSummaryRecordIOD, ScheduledStepAttributesSequence.Item, SecondaryCaptureImageIOD, SegmentationIOD, SimplifiedAdultEchoSRIOD, SleepElectroencephalogramIOD, SpatialFiducialsIOD, SpatialRegistrationIOD, SpectaclePrescriptionReportIOD, StereometricRelationshipIOD, SubjectiveRefractionMeasurementsIOD, SurfaceScanMeshIOD, SurfaceScanPointCloudIOD, SurfaceSegmentationIOD, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD, TractographyResultsIOD, TwelveLeadECGIOD, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VisitRelationshipModule.SimpleWrapper, VisualAcuityMeasurementsIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, VolumeRenderingVolumetricPresentationStateIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XAPerformedProcedureProtocolIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiationDoseSRIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

ReferencedStudySequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedStudySequence.Holder.Builder	builder()
static ReferencedStudySequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedStudySequence()
default ReferencedStudySequence	ensureReferencedStudySequence()	Adds a new Referenced Study Sequence (see ReferencedStudySequence) with initial capacity 1 (see ensureReferencedStudySequence(int)) if it does not already exist.
default ReferencedStudySequence	ensureReferencedStudySequence(int initialCapacity)	Adds a new Referenced Study Sequence (see ReferencedStudySequence) if it does not already exist.
default ReferencedStudySequence	getReferencedStudySequence()
default ReferencedStudySequence	newReferencedStudySequence(int initialCapacity)	Adds a new Referenced Study Sequence.
default void	removeReferencedStudySequence()	Removes the Referenced Study Sequence (see ReferencedStudySequence
static ReferencedStudySequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Study Sequence (see ReferencedStudySequence)

Returns:

a wrapper object implementing the ReferencedStudySequence.Holder interface.

builder

static ReferencedStudySequence.Holder.Builder builder()

Returns:

a ReferencedStudySequence.Holder.Builder to create Referenced Study Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getReferencedStudySequence

default ReferencedStudySequence getReferencedStudySequence()

Returns:

the Referenced Study Sequence (see ReferencedStudySequence)

newReferencedStudySequence

default ReferencedStudySequence newReferencedStudySequence(int initialCapacity)

Adds a new Referenced Study Sequence. (see ReferencedStudySequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Study Sequence

Returns:

the newly created ReferencedStudySequence.

ensureReferencedStudySequence

default ReferencedStudySequence ensureReferencedStudySequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureReferencedStudySequence

default ReferencedStudySequence ensureReferencedStudySequence()

Adds a new Referenced Study Sequence (see ReferencedStudySequence) with initial capacity 1 (see ensureReferencedStudySequence(int)) if it does not already exist.

Returns:

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

containsReferencedStudySequence

default boolean containsReferencedStudySequence()

Returns:

whether it contains the Referenced Study Sequence (see ReferencedStudySequence)

removeReferencedStudySequence

default void removeReferencedStudySequence()

Removes the Referenced Study Sequence (see ReferencedStudySequence