Package org.dcm4che.typeddicom.dataelements

Interface PredecessorDocumentsSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

EncapsulatedDocumentModule, SRDocumentGeneralModule

All Known Implementing Classes:

AcquisitionContextSRIOD, BasicTextSRIOD, ChestCADSRIOD, ColonCADSRIOD, Comprehensive3DSRIOD, ComprehensiveSRIOD, EncapsulatedCDAIOD, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, EnhancedSRIOD, EnhancedXRayRadiationDoseStructuredReportIOD, ExtensibleSRIOD, ImplantationPlanSRDocumentIOD, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, PatientRadiationDoseStructuredReportIOD, PerformedImagingAgentAdministrationSRIOD, PlannedImagingAgentAdministrationSRIOD, PredecessorDocumentsSequence.SimpleHolder, ProcedureLogIOD, RadiopharmaceuticalRadiationDoseSRIOD, SimplifiedAdultEchoSRIOD, SpectaclePrescriptionReportIOD, XRayRadiationDoseSRIOD

Enclosing class:

PredecessorDocumentsSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Predecessor Documents Sequence" (see PredecessorDocumentsSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PredecessorDocumentsSequence.Holder.Builder	builder()
static PredecessorDocumentsSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPredecessorDocumentsSequence()
default PredecessorDocumentsSequence	ensurePredecessorDocumentsSequence()	Adds a new Predecessor Documents Sequence (see PredecessorDocumentsSequence) with initial capacity 1 (see ensurePredecessorDocumentsSequence(int)) if it does not already exist.
default PredecessorDocumentsSequence	ensurePredecessorDocumentsSequence(int initialCapacity)	Adds a new Predecessor Documents Sequence (see PredecessorDocumentsSequence) if it does not already exist.
default PredecessorDocumentsSequence	getPredecessorDocumentsSequence()
default PredecessorDocumentsSequence	newPredecessorDocumentsSequence(int initialCapacity)	Adds a new Predecessor Documents Sequence.
default void	removePredecessorDocumentsSequence()	Removes the Predecessor Documents Sequence (see PredecessorDocumentsSequence
static PredecessorDocumentsSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Predecessor Documents Sequence (see PredecessorDocumentsSequence)

Returns:

a wrapper object implementing the PredecessorDocumentsSequence.Holder interface.

builder

static PredecessorDocumentsSequence.Holder.Builder builder()

Returns:

a PredecessorDocumentsSequence.Holder.Builder to create Predecessor Documents Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PredecessorDocumentsSequence.Holder.Builder to create Predecessor Documents Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPredecessorDocumentsSequence

default PredecessorDocumentsSequence getPredecessorDocumentsSequence()

Returns:

the Predecessor Documents Sequence (see PredecessorDocumentsSequence)

newPredecessorDocumentsSequence

default PredecessorDocumentsSequence newPredecessorDocumentsSequence(int initialCapacity)

Adds a new Predecessor Documents Sequence. (see PredecessorDocumentsSequence)

Parameters:

initialCapacity - the initial capacity for the new Predecessor Documents Sequence

Returns:

the newly created PredecessorDocumentsSequence.

ensurePredecessorDocumentsSequence

default PredecessorDocumentsSequence ensurePredecessorDocumentsSequence(int initialCapacity)

Adds a new Predecessor Documents Sequence (see PredecessorDocumentsSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Predecessor Documents Sequence (see PredecessorDocumentsSequence) or a new one with capacity initialCapacity.

ensurePredecessorDocumentsSequence

default PredecessorDocumentsSequence ensurePredecessorDocumentsSequence()

Adds a new Predecessor Documents Sequence (see PredecessorDocumentsSequence) with initial capacity 1 (see ensurePredecessorDocumentsSequence(int)) if it does not already exist.

Returns:

either the already existing Predecessor Documents Sequence (see PredecessorDocumentsSequence) or a new one with capacity 1.

containsPredecessorDocumentsSequence

default boolean containsPredecessorDocumentsSequence()

Returns:

whether it contains the Predecessor Documents Sequence (see PredecessorDocumentsSequence)

removePredecessorDocumentsSequence

default void removePredecessorDocumentsSequence()

Removes the Predecessor Documents Sequence (see PredecessorDocumentsSequence