Package org.dcm4che.typeddicom.dataelements

Interface ParticipantSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

SRDocumentGeneralModule

All Known Implementing Classes:

AcquisitionContextSRIOD, BasicTextSRIOD, ChestCADSRIOD, ColonCADSRIOD, Comprehensive3DSRIOD, ComprehensiveSRIOD, EnhancedSRIOD, EnhancedXRayRadiationDoseStructuredReportIOD, ExtensibleSRIOD, ImplantationPlanSRDocumentIOD, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, PatientRadiationDoseStructuredReportIOD, PerformedImagingAgentAdministrationSRIOD, PlannedImagingAgentAdministrationSRIOD, ProcedureLogIOD, RadiopharmaceuticalRadiationDoseSRIOD, SimplifiedAdultEchoSRIOD, SpectaclePrescriptionReportIOD, SRDocumentGeneralModule.SimpleWrapper, XRayRadiationDoseSRIOD

Enclosing class:

ParticipantSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Participant Sequence" (see ParticipantSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ParticipantSequence.Holder.Builder	builder()
static ParticipantSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsParticipantSequence()
default ParticipantSequence	ensureParticipantSequence()	Adds a new Participant Sequence (see ParticipantSequence) with initial capacity 1 (see ensureParticipantSequence(int)) if it does not already exist.
default ParticipantSequence	ensureParticipantSequence(int initialCapacity)	Adds a new Participant Sequence (see ParticipantSequence) if it does not already exist.
default ParticipantSequence	getParticipantSequence()
default ParticipantSequence	newParticipantSequence(int initialCapacity)	Adds a new Participant Sequence.
default void	removeParticipantSequence()	Removes the Participant Sequence (see ParticipantSequence
static ParticipantSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Participant Sequence (see ParticipantSequence)

Returns:

a wrapper object implementing the ParticipantSequence.Holder interface.

builder

static ParticipantSequence.Holder.Builder builder()

Returns:

a ParticipantSequence.Holder.Builder to create Participant Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getParticipantSequence

default ParticipantSequence getParticipantSequence()

Returns:

the Participant Sequence (see ParticipantSequence)

newParticipantSequence

default ParticipantSequence newParticipantSequence(int initialCapacity)

Adds a new Participant Sequence. (see ParticipantSequence)

Parameters:

initialCapacity - the initial capacity for the new Participant Sequence

Returns:

the newly created ParticipantSequence.

ensureParticipantSequence

default ParticipantSequence ensureParticipantSequence(int initialCapacity)

Adds a new Participant Sequence (see ParticipantSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Participant Sequence (see ParticipantSequence) or a new one with capacity initialCapacity.

ensureParticipantSequence

default ParticipantSequence ensureParticipantSequence()

Adds a new Participant Sequence (see ParticipantSequence) with initial capacity 1 (see ensureParticipantSequence(int)) if it does not already exist.

Returns:

either the already existing Participant Sequence (see ParticipantSequence) or a new one with capacity 1.

containsParticipantSequence

default boolean containsParticipantSequence()

Returns:

whether it contains the Participant Sequence (see ParticipantSequence)

removeParticipantSequence

default void removeParticipantSequence()

Removes the Participant Sequence (see ParticipantSequence