Package org.dcm4che.typeddicom.dataelements

Interface SpecimenDescriptionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

SpecimenModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, CRImageIOD, CTImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, InventoriedInstancesSequence.Item, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, MicroscopyBulkSimpleAnnotationsIOD, MRImageIOD, MRSpectroscopyIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, ParametricMapIOD, PETImageIOD, RawDataIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, ReferencedImageSequence.Item, ScheduledSpecimenSequence.Item, SecondaryCaptureImageIOD, SegmentationIOD, SpecimenModule.SimpleWrapper, SurfaceScanMeshIOD, SurfaceScanPointCloudIOD, TractographyResultsIOD, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

SpecimenDescriptionSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Specimen Description Sequence" (see SpecimenDescriptionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SpecimenDescriptionSequence.Holder.Builder	builder()
static SpecimenDescriptionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSpecimenDescriptionSequence()
default SpecimenDescriptionSequence	ensureSpecimenDescriptionSequence()	Adds a new Specimen Description Sequence (see SpecimenDescriptionSequence) with initial capacity 1 (see ensureSpecimenDescriptionSequence(int)) if it does not already exist.
default SpecimenDescriptionSequence	ensureSpecimenDescriptionSequence(int initialCapacity)	Adds a new Specimen Description Sequence (see SpecimenDescriptionSequence) if it does not already exist.
default SpecimenDescriptionSequence	getSpecimenDescriptionSequence()
default SpecimenDescriptionSequence	newSpecimenDescriptionSequence(int initialCapacity)	Adds a new Specimen Description Sequence.
default void	removeSpecimenDescriptionSequence()	Removes the Specimen Description Sequence (see SpecimenDescriptionSequence
static SpecimenDescriptionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Specimen Description Sequence (see SpecimenDescriptionSequence)

Returns:

a wrapper object implementing the SpecimenDescriptionSequence.Holder interface.

builder

static SpecimenDescriptionSequence.Holder.Builder builder()

Returns:

a SpecimenDescriptionSequence.Holder.Builder to create Specimen Description Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a SpecimenDescriptionSequence.Holder.Builder to create Specimen Description Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getSpecimenDescriptionSequence

default SpecimenDescriptionSequence getSpecimenDescriptionSequence()

Returns:

the Specimen Description Sequence (see SpecimenDescriptionSequence)

newSpecimenDescriptionSequence

default SpecimenDescriptionSequence newSpecimenDescriptionSequence(int initialCapacity)

Adds a new Specimen Description Sequence. (see SpecimenDescriptionSequence)

Parameters:

initialCapacity - the initial capacity for the new Specimen Description Sequence

Returns:

the newly created SpecimenDescriptionSequence.

ensureSpecimenDescriptionSequence

default SpecimenDescriptionSequence ensureSpecimenDescriptionSequence(int initialCapacity)

Adds a new Specimen Description Sequence (see SpecimenDescriptionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Specimen Description Sequence (see SpecimenDescriptionSequence) or a new one with capacity initialCapacity.

ensureSpecimenDescriptionSequence

default SpecimenDescriptionSequence ensureSpecimenDescriptionSequence()

Adds a new Specimen Description Sequence (see SpecimenDescriptionSequence) with initial capacity 1 (see ensureSpecimenDescriptionSequence(int)) if it does not already exist.

Returns:

either the already existing Specimen Description Sequence (see SpecimenDescriptionSequence) or a new one with capacity 1.

containsSpecimenDescriptionSequence

default boolean containsSpecimenDescriptionSequence()

Returns:

whether it contains the Specimen Description Sequence (see SpecimenDescriptionSequence)

removeSpecimenDescriptionSequence

default void removeSpecimenDescriptionSequence()

Removes the Specimen Description Sequence (see SpecimenDescriptionSequence