Package org.dcm4che.typeddicom.dataelements

Interface ReferencedRequestSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

KeyObjectDocumentModule, SRDocumentGeneralModule, UnifiedProcedureStepRelationshipModule

All Known Implementing Classes:

AcquisitionContextSRIOD, BasicTextSRIOD, ChestCADSRIOD, ColonCADSRIOD, Comprehensive3DSRIOD, ComprehensiveSRIOD, EnhancedSRIOD, EnhancedXRayRadiationDoseStructuredReportIOD, ExtensibleSRIOD, ImplantationPlanSRDocumentIOD, InventoriedInstancesSequence.Item, KeyObjectDocumentModule.SimpleWrapper, KeyObjectSelectionDocumentIOD, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, PatientRadiationDoseStructuredReportIOD, PerformedImagingAgentAdministrationSRIOD, PlannedImagingAgentAdministrationSRIOD, ProcedureLogIOD, RadiopharmaceuticalRadiationDoseSRIOD, RenditionSelectionDocumentIOD, SimplifiedAdultEchoSRIOD, SpectaclePrescriptionReportIOD, SRDocumentGeneralModule.SimpleWrapper, UnifiedProcedureStepIOD, UnifiedProcedureStepRelationshipModule.SimpleWrapper, XRayRadiationDoseSRIOD

Enclosing class:

ReferencedRequestSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Request Sequence" (see ReferencedRequestSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedRequestSequence.Holder.Builder	builder()
static ReferencedRequestSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedRequestSequence()
default ReferencedRequestSequence	ensureReferencedRequestSequence()	Adds a new Referenced Request Sequence (see ReferencedRequestSequence) with initial capacity 1 (see ensureReferencedRequestSequence(int)) if it does not already exist.
default ReferencedRequestSequence	ensureReferencedRequestSequence(int initialCapacity)	Adds a new Referenced Request Sequence (see ReferencedRequestSequence) if it does not already exist.
default ReferencedRequestSequence	getReferencedRequestSequence()
default ReferencedRequestSequence	newReferencedRequestSequence(int initialCapacity)	Adds a new Referenced Request Sequence.
default void	removeReferencedRequestSequence()	Removes the Referenced Request Sequence (see ReferencedRequestSequence
static ReferencedRequestSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Referenced Request Sequence (see ReferencedRequestSequence)

Returns:

a wrapper object implementing the ReferencedRequestSequence.Holder interface.

builder

static ReferencedRequestSequence.Holder.Builder builder()

Returns:

a ReferencedRequestSequence.Holder.Builder to create Referenced Request Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a ReferencedRequestSequence.Holder.Builder to create Referenced Request Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getReferencedRequestSequence

default ReferencedRequestSequence getReferencedRequestSequence()

Returns:

the Referenced Request Sequence (see ReferencedRequestSequence)

newReferencedRequestSequence

default ReferencedRequestSequence newReferencedRequestSequence(int initialCapacity)

Adds a new Referenced Request Sequence. (see ReferencedRequestSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced Request Sequence

Returns:

the newly created ReferencedRequestSequence.

ensureReferencedRequestSequence

default ReferencedRequestSequence ensureReferencedRequestSequence(int initialCapacity)

Adds a new Referenced Request Sequence (see ReferencedRequestSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Referenced Request Sequence (see ReferencedRequestSequence) or a new one with capacity initialCapacity.

ensureReferencedRequestSequence

default ReferencedRequestSequence ensureReferencedRequestSequence()

Adds a new Referenced Request Sequence (see ReferencedRequestSequence) with initial capacity 1 (see ensureReferencedRequestSequence(int)) if it does not already exist.

Returns:

either the already existing Referenced Request Sequence (see ReferencedRequestSequence) or a new one with capacity 1.

containsReferencedRequestSequence

default boolean containsReferencedRequestSequence()

Returns:

whether it contains the Referenced Request Sequence (see ReferencedRequestSequence)

removeReferencedRequestSequence

default void removeReferencedRequestSequence()

Removes the Referenced Request Sequence (see ReferencedRequestSequence