Package org.dcm4che.typeddicom.dataelements

Interface CustodialOrganizationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

ProtocolContextModule, SRDocumentGeneralModule

All Known Implementing Classes:

AcquisitionContextSRIOD, BasicTextSRIOD, ChestCADSRIOD, ColonCADSRIOD, Comprehensive3DSRIOD, ComprehensiveSRIOD, CTDefinedProcedureProtocolIOD, CTPerformedProcedureProtocolIOD, CustodialOrganizationSequence.SimpleHolder, EnhancedSRIOD, EnhancedXRayRadiationDoseStructuredReportIOD, ExtensibleSRIOD, ImplantationPlanSRDocumentIOD, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, PatientRadiationDoseStructuredReportIOD, PerformedImagingAgentAdministrationSRIOD, PlannedImagingAgentAdministrationSRIOD, ProcedureLogIOD, RadiopharmaceuticalRadiationDoseSRIOD, SimplifiedAdultEchoSRIOD, SpectaclePrescriptionReportIOD, XADefinedProcedureProtocolIOD, XAPerformedProcedureProtocolIOD, XRayRadiationDoseSRIOD

Enclosing class:

CustodialOrganizationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Custodial Organization Sequence" (see CustodialOrganizationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CustodialOrganizationSequence.Holder.Builder	builder()
static CustodialOrganizationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsCustodialOrganizationSequence()
default CustodialOrganizationSequence	ensureCustodialOrganizationSequence()	Adds a new Custodial Organization Sequence (see CustodialOrganizationSequence) with initial capacity 1 (see ensureCustodialOrganizationSequence(int)) if it does not already exist.
default CustodialOrganizationSequence	ensureCustodialOrganizationSequence(int initialCapacity)	Adds a new Custodial Organization Sequence (see CustodialOrganizationSequence) if it does not already exist.
default CustodialOrganizationSequence	getCustodialOrganizationSequence()
default CustodialOrganizationSequence	newCustodialOrganizationSequence(int initialCapacity)	Adds a new Custodial Organization Sequence.
default void	removeCustodialOrganizationSequence()	Removes the Custodial Organization Sequence (see CustodialOrganizationSequence
static CustodialOrganizationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Custodial Organization Sequence (see CustodialOrganizationSequence)

Returns:

a wrapper object implementing the CustodialOrganizationSequence.Holder interface.

builder

static CustodialOrganizationSequence.Holder.Builder builder()

Returns:

a CustodialOrganizationSequence.Holder.Builder to create Custodial Organization Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getCustodialOrganizationSequence

default CustodialOrganizationSequence getCustodialOrganizationSequence()

Returns:

the Custodial Organization Sequence (see CustodialOrganizationSequence)

newCustodialOrganizationSequence

default CustodialOrganizationSequence newCustodialOrganizationSequence(int initialCapacity)

Adds a new Custodial Organization Sequence. (see CustodialOrganizationSequence)

Parameters:

initialCapacity - the initial capacity for the new Custodial Organization Sequence

Returns:

the newly created CustodialOrganizationSequence.

ensureCustodialOrganizationSequence

default CustodialOrganizationSequence ensureCustodialOrganizationSequence(int initialCapacity)

Adds a new Custodial Organization Sequence (see CustodialOrganizationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Custodial Organization Sequence (see CustodialOrganizationSequence) or a new one with capacity initialCapacity.

ensureCustodialOrganizationSequence

default CustodialOrganizationSequence ensureCustodialOrganizationSequence()

Adds a new Custodial Organization Sequence (see CustodialOrganizationSequence) with initial capacity 1 (see ensureCustodialOrganizationSequence(int)) if it does not already exist.

Returns:

either the already existing Custodial Organization Sequence (see CustodialOrganizationSequence) or a new one with capacity 1.

containsCustodialOrganizationSequence

default boolean containsCustodialOrganizationSequence()

Returns:

whether it contains the Custodial Organization Sequence (see CustodialOrganizationSequence)

removeCustodialOrganizationSequence

default void removeCustodialOrganizationSequence()

Removes the Custodial Organization Sequence (see CustodialOrganizationSequence