Package org.dcm4che.typeddicom.dataelements

Interface PatientSpeciesCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

PatientDemographicModule, PatientModule

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, MRImageIOD, MRSpectroscopyIOD, MultiChannelRespiratoryWaveformIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicAxialMeasurementsIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, OphthalmicTomographyImageIOD, OphthalmicVisualFieldStaticPerimetryMeasurementsIOD, ParametricMapIOD, PatientRadiationDoseStructuredReportIOD, PatientSpeciesCodeSequence.SimpleHolder, PerformedImagingAgentAdministrationSRIOD, PETImageIOD, PlanarMPRVolumetricPresentationStateIOD, PlannedImagingAgentAdministrationSRIOD, ProcedureLogIOD, PseudoColorSoftcopyPresentationStateIOD, RadiopharmaceuticalRadiationDoseSRIOD, RawDataIOD, RealTimeAudioWaveformIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RealWorldValueMappingIOD, 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, UnifiedProcedureStepIOD, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VisualAcuityMeasurementsIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, VolumeRenderingVolumetricPresentationStateIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XAPerformedProcedureProtocolIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiationDoseSRIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

PatientSpeciesCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Patient Species Code Sequence" (see PatientSpeciesCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PatientSpeciesCodeSequence.Holder.Builder	builder()
static PatientSpeciesCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPatientSpeciesCodeSequence()
default PatientSpeciesCodeSequence	ensurePatientSpeciesCodeSequence()	Adds a new Patient Species Code Sequence (see PatientSpeciesCodeSequence) with initial capacity 1 (see ensurePatientSpeciesCodeSequence(int)) if it does not already exist.
default PatientSpeciesCodeSequence	ensurePatientSpeciesCodeSequence(int initialCapacity)	Adds a new Patient Species Code Sequence (see PatientSpeciesCodeSequence) if it does not already exist.
default PatientSpeciesCodeSequence	getPatientSpeciesCodeSequence()
default PatientSpeciesCodeSequence	newPatientSpeciesCodeSequence(int initialCapacity)	Adds a new Patient Species Code Sequence.
default void	removePatientSpeciesCodeSequence()	Removes the Patient Species Code Sequence (see PatientSpeciesCodeSequence
static PatientSpeciesCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Patient Species Code Sequence (see PatientSpeciesCodeSequence)

Returns:

a wrapper object implementing the PatientSpeciesCodeSequence.Holder interface.

builder

static PatientSpeciesCodeSequence.Holder.Builder builder()

Returns:

a PatientSpeciesCodeSequence.Holder.Builder to create Patient Species Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPatientSpeciesCodeSequence

default PatientSpeciesCodeSequence getPatientSpeciesCodeSequence()

Returns:

the Patient Species Code Sequence (see PatientSpeciesCodeSequence)

newPatientSpeciesCodeSequence

default PatientSpeciesCodeSequence newPatientSpeciesCodeSequence(int initialCapacity)

Adds a new Patient Species Code Sequence. (see PatientSpeciesCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Patient Species Code Sequence

Returns:

the newly created PatientSpeciesCodeSequence.

ensurePatientSpeciesCodeSequence

default PatientSpeciesCodeSequence ensurePatientSpeciesCodeSequence(int initialCapacity)

Adds a new Patient Species Code Sequence (see PatientSpeciesCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Patient Species Code Sequence (see PatientSpeciesCodeSequence) or a new one with capacity initialCapacity.

ensurePatientSpeciesCodeSequence

default PatientSpeciesCodeSequence ensurePatientSpeciesCodeSequence()

Adds a new Patient Species Code Sequence (see PatientSpeciesCodeSequence) with initial capacity 1 (see ensurePatientSpeciesCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Patient Species Code Sequence (see PatientSpeciesCodeSequence) or a new one with capacity 1.

containsPatientSpeciesCodeSequence

default boolean containsPatientSpeciesCodeSequence()

Returns:

whether it contains the Patient Species Code Sequence (see PatientSpeciesCodeSequence)

removePatientSpeciesCodeSequence

default void removePatientSpeciesCodeSequence()

Removes the Patient Species Code Sequence (see PatientSpeciesCodeSequence