Package org.dcm4che.typeddicom.dataelements

Interface ProtocolName.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

EncapsulatedDocumentSeriesModule, GeneralSeriesModule, KeyObjectDocumentSeriesModule, ProtocolContextModule, SRDocumentSeriesModule

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, ContributingSourcesSequence.Item, CornealTopographyMapIOD, CRImageIOD, CTDefinedProcedureProtocolIOD, 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, MRImageIOD, MRSpectroscopyIOD, MultiChannelRespiratoryWaveformIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicAxialMeasurementsIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, OphthalmicTomographyImageIOD, OphthalmicVisualFieldStaticPerimetryMeasurementsIOD, ParametricMapIOD, PatientRadiationDoseStructuredReportIOD, PerformedImagingAgentAdministrationSRIOD, PerformedSeriesSequence.Item, PETImageIOD, PlanarMPRVolumetricPresentationStateIOD, PlannedImagingAgentAdministrationSRIOD, ProcedureLogIOD, ProtocolName.SimpleHolder, PseudoColorSoftcopyPresentationStateIOD, RadiopharmaceuticalRadiationDoseSRIOD, RawDataIOD, RealTimeAudioWaveformIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RealWorldValueMappingIOD, RenditionSelectionDocumentIOD, RespiratoryWaveformIOD, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RoutineScalpElectroencephalogramIOD, RTBeamsDeliveryInstructionIOD, RTBrachyApplicationSetupDeliveryInstructionIOD, RTPhysicianIntentIOD, RTRadiationRecordSetIOD, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetIOD, RTSegmentAnnotationIOD, RTTreatmentPreparationIOD, 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, XADefinedProcedureProtocolIOD, XAPerformedProcedureProtocolIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiationDoseSRIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

ProtocolName

public static interface ProtocolName.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Protocol Name" (see ProtocolName)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ProtocolName.Holder.Builder	builder()
static ProtocolName.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsProtocolName()
default ProtocolName	getProtocolName()
default void	removeProtocolName()	Removes the Protocol Name (see ProtocolName
static ProtocolName.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Protocol Name (see ProtocolName)

Returns:

A wrapper object implementing the ProtocolName.Holder interface.

builder

static ProtocolName.Holder.Builder builder()

Returns:

a ProtocolName.Holder.Builder to create Protocol Name Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ProtocolName.Holder.Builder to create Protocol Name Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getProtocolName

default ProtocolName getProtocolName()

Returns:

the Protocol Name (see ProtocolName)

containsProtocolName

default boolean containsProtocolName()

Returns:

Whether it contains the Protocol Name (see ProtocolName)

removeProtocolName

default void removeProtocolName()

Removes the Protocol Name (see ProtocolName