Package org.dcm4che.typeddicom.dataelements

Interface DerivationCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

GeneralReferenceModule, RTDoseModule

All Known Implementing Classes:

CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, CornealTopographyMapIOD, CRImageIOD, CTImageIOD, DeformableSpatialRegistrationIOD, DerivationCodeSequence.SimpleHolder, DerivationImageSequence.Item, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, EnhancedUSVolumeIOD, MRImageIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, ParametricMapIOD, PETImageIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, ReconstructionProtocolElementSequence.Item, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RTBeamsDeliveryInstructionIOD, RTBeamsTreatmentRecordIOD, RTBrachyApplicationSetupDeliveryInstructionIOD, RTBrachyTreatmentRecordIOD, RTDoseIOD, RTImageIOD, RTIonBeamsTreatmentRecordIOD, RTIonPlanIOD, RTPhysicianIntentIOD, RTPlanIOD, RTRadiationRecordSetIOD, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetIOD, RTSegmentAnnotationIOD, RTStructureSetIOD, RTTreatmentPreparationIOD, RTTreatmentSummaryRecordIOD, SecondaryCaptureImageIOD, SegmentationIOD, SpatialFiducialsIOD, SpatialRegistrationIOD, StructureSetROISequence.Item, SurfaceSegmentationIOD, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

DerivationCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Derivation Code Sequence" (see DerivationCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DerivationCodeSequence.Holder.Builder	builder()
static DerivationCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsDerivationCodeSequence()
default DerivationCodeSequence	ensureDerivationCodeSequence()	Adds a new Derivation Code Sequence (see DerivationCodeSequence) with initial capacity 1 (see ensureDerivationCodeSequence(int)) if it does not already exist.
default DerivationCodeSequence	ensureDerivationCodeSequence(int initialCapacity)	Adds a new Derivation Code Sequence (see DerivationCodeSequence) if it does not already exist.
default DerivationCodeSequence	getDerivationCodeSequence()
default DerivationCodeSequence	newDerivationCodeSequence(int initialCapacity)	Adds a new Derivation Code Sequence.
default void	removeDerivationCodeSequence()	Removes the Derivation Code Sequence (see DerivationCodeSequence
static DerivationCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Derivation Code Sequence (see DerivationCodeSequence)

Returns:

a wrapper object implementing the DerivationCodeSequence.Holder interface.

builder

static DerivationCodeSequence.Holder.Builder builder()

Returns:

a DerivationCodeSequence.Holder.Builder to create Derivation Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getDerivationCodeSequence

default DerivationCodeSequence getDerivationCodeSequence()

Returns:

the Derivation Code Sequence (see DerivationCodeSequence)

newDerivationCodeSequence

default DerivationCodeSequence newDerivationCodeSequence(int initialCapacity)

Adds a new Derivation Code Sequence. (see DerivationCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Derivation Code Sequence

Returns:

the newly created DerivationCodeSequence.

ensureDerivationCodeSequence

default DerivationCodeSequence ensureDerivationCodeSequence(int initialCapacity)

Adds a new Derivation Code Sequence (see DerivationCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Derivation Code Sequence (see DerivationCodeSequence) or a new one with capacity initialCapacity.

ensureDerivationCodeSequence

default DerivationCodeSequence ensureDerivationCodeSequence()

Adds a new Derivation Code Sequence (see DerivationCodeSequence) with initial capacity 1 (see ensureDerivationCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Derivation Code Sequence (see DerivationCodeSequence) or a new one with capacity 1.

containsDerivationCodeSequence

default boolean containsDerivationCodeSequence()

Returns:

whether it contains the Derivation Code Sequence (see DerivationCodeSequence)

removeDerivationCodeSequence

default void removeDerivationCodeSequence()

Removes the Derivation Code Sequence (see DerivationCodeSequence