Package org.dcm4che.typeddicom.dataelements

Interface PrimaryAnatomicStructureSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

CornealTopographyMapImageModule, CRImageModule, CTImageModule, DXAnatomyImagedModule, EnhancedUSImageModule, GeneralImageModule, IntraOralImageModule, MammographyImageModule, MRImageModule, NMImageModule, OcularRegionImagedModule, OphthalmicThicknessMapModule, PatientPositioningModule, PETImageModule, PresentationViewDescriptionModule, USImageModule, VLImageModule, WideFieldOphthalmicPhotography3DCoordinatesModule, WideFieldOphthalmicPhotographyStereographicProjectionModule, XRayImageModule

All Known Implementing Classes:

AnnotationGroupSequence.Item, ComputedRadiographyImageIOD, CornealTopographyMapImageModule.SimpleWrapper, CornealTopographyMapIOD, CRImageModule.SimpleWrapper, CTDefinedProcedureProtocolIOD, CTImageIOD, CTImageModule.SimpleWrapper, CTPerformedProcedureProtocolIOD, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, DXAnatomyImagedModule.SimpleWrapper, EnhancedUSImageModule.SimpleWrapper, EnhancedUSVolumeIOD, FrameAnatomySequence.Item, GeneralImageModule.SimpleWrapper, IntraOralImageModule.SimpleWrapper, MammographyImageModule.SimpleWrapper, MRImageIOD, MRImageModule.SimpleWrapper, MultiFrameGrayscaleByteSecondaryCaptureImageIOD, MultiFrameGrayscaleWordSecondaryCaptureImageIOD, MultiFrameSingleBitSecondaryCaptureImageIOD, MultiFrameTrueColorSecondaryCaptureImageIOD, NMImageModule.SimpleWrapper, NuclearMedicineImageIOD, OcularRegionImagedModule.SimpleWrapper, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, OphthalmicThicknessMapModule.SimpleWrapper, OphthalmicTomographyImageIOD, ParametricMapIOD, PatientPositioningModule.SimpleWrapper, PETImageModule.SimpleWrapper, PlanarMPRVolumetricPresentationStateIOD, PositronEmissionTomographyImageIOD, PresentationViewDescriptionModule.SimpleWrapper, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RTDoseIOD, RTImageIOD, RTROIObservationsSequence.Item, SecondaryCaptureImageIOD, SegmentationIOD, SegmentSequence.Item, SpecimenDescriptionSequence.Item, UltrasoundImageIOD, UltrasoundMultiFrameImageIOD, USImageModule.SimpleWrapper, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VLEndoscopicImageIOD, VLImageModule.SimpleWrapper, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, VolumeRenderingVolumetricPresentationStateIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotography3DCoordinatesModule.SimpleWrapper, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionModule.SimpleWrapper, XADefinedProcedureProtocolIOD, XAPerformedProcedureProtocolIOD, XRayAngiographicImageIOD, XRayImageModule.SimpleWrapper, XRayRadiofluoroscopicImageIOD

Enclosing class:

PrimaryAnatomicStructureSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Primary Anatomic Structure Sequence" (see PrimaryAnatomicStructureSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PrimaryAnatomicStructureSequence.Holder.Builder	builder()
static PrimaryAnatomicStructureSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPrimaryAnatomicStructureSequence()
default PrimaryAnatomicStructureSequence	ensurePrimaryAnatomicStructureSequence()	Adds a new Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence) with initial capacity 1 (see ensurePrimaryAnatomicStructureSequence(int)) if it does not already exist.
default PrimaryAnatomicStructureSequence	ensurePrimaryAnatomicStructureSequence(int initialCapacity)	Adds a new Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence) if it does not already exist.
default PrimaryAnatomicStructureSequence	getPrimaryAnatomicStructureSequence()
default PrimaryAnatomicStructureSequence	newPrimaryAnatomicStructureSequence(int initialCapacity)	Adds a new Primary Anatomic Structure Sequence.
default void	removePrimaryAnatomicStructureSequence()	Removes the Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence
static PrimaryAnatomicStructureSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence)

Returns:

a wrapper object implementing the PrimaryAnatomicStructureSequence.Holder interface.

builder

static PrimaryAnatomicStructureSequence.Holder.Builder builder()

Returns:

a PrimaryAnatomicStructureSequence.Holder.Builder to create Primary Anatomic Structure Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PrimaryAnatomicStructureSequence.Holder.Builder to create Primary Anatomic Structure Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPrimaryAnatomicStructureSequence

default PrimaryAnatomicStructureSequence getPrimaryAnatomicStructureSequence()

Returns:

the Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence)

newPrimaryAnatomicStructureSequence

default PrimaryAnatomicStructureSequence newPrimaryAnatomicStructureSequence(int initialCapacity)

Adds a new Primary Anatomic Structure Sequence. (see PrimaryAnatomicStructureSequence)

Parameters:

initialCapacity - the initial capacity for the new Primary Anatomic Structure Sequence

Returns:

the newly created PrimaryAnatomicStructureSequence.

ensurePrimaryAnatomicStructureSequence

default PrimaryAnatomicStructureSequence ensurePrimaryAnatomicStructureSequence(int initialCapacity)

Adds a new Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Primary Anatomic Structure Sequence is created.

Returns:

either the already existing Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence) or a new one with capacity initialCapacity.

ensurePrimaryAnatomicStructureSequence

default PrimaryAnatomicStructureSequence ensurePrimaryAnatomicStructureSequence()

Adds a new Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence) with initial capacity 1 (see ensurePrimaryAnatomicStructureSequence(int)) if it does not already exist.

Returns:

either the already existing Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence) or a new one with capacity 1.

containsPrimaryAnatomicStructureSequence

default boolean containsPrimaryAnatomicStructureSequence()

Returns:

whether it contains the Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence)

removePrimaryAnatomicStructureSequence

default void removePrimaryAnatomicStructureSequence()

Removes the Primary Anatomic Structure Sequence (see PrimaryAnatomicStructureSequence