Package org.dcm4che.typeddicom.dataelements

Interface PertinentDocumentsSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

PatientMedicalModule, ProductCharacteristicsModule

All Known Implementing Classes:

ApprovalSequence.Item, ConfirmationSequence.Item, PertinentDocumentsSequence.SimpleHolder, UnifiedProcedureStepIOD

Enclosing class:

PertinentDocumentsSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PertinentDocumentsSequence.Holder.Builder	builder()
static PertinentDocumentsSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPertinentDocumentsSequence()
default PertinentDocumentsSequence	ensurePertinentDocumentsSequence()	Adds a new Pertinent Documents Sequence (see PertinentDocumentsSequence) with initial capacity 1 (see ensurePertinentDocumentsSequence(int)) if it does not already exist.
default PertinentDocumentsSequence	ensurePertinentDocumentsSequence(int initialCapacity)	Adds a new Pertinent Documents Sequence (see PertinentDocumentsSequence) if it does not already exist.
default PertinentDocumentsSequence	getPertinentDocumentsSequence()
default PertinentDocumentsSequence	newPertinentDocumentsSequence(int initialCapacity)	Adds a new Pertinent Documents Sequence.
default void	removePertinentDocumentsSequence()	Removes the Pertinent Documents Sequence (see PertinentDocumentsSequence
static PertinentDocumentsSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Pertinent Documents Sequence (see PertinentDocumentsSequence)

Returns:

a wrapper object implementing the PertinentDocumentsSequence.Holder interface.

builder

static PertinentDocumentsSequence.Holder.Builder builder()

Returns:

a PertinentDocumentsSequence.Holder.Builder to create Pertinent Documents Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPertinentDocumentsSequence

default PertinentDocumentsSequence getPertinentDocumentsSequence()

Returns:

the Pertinent Documents Sequence (see PertinentDocumentsSequence)

newPertinentDocumentsSequence

default PertinentDocumentsSequence newPertinentDocumentsSequence(int initialCapacity)

Adds a new Pertinent Documents Sequence. (see PertinentDocumentsSequence)

Parameters:

initialCapacity - the initial capacity for the new Pertinent Documents Sequence

Returns:

the newly created PertinentDocumentsSequence.

ensurePertinentDocumentsSequence

default PertinentDocumentsSequence ensurePertinentDocumentsSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensurePertinentDocumentsSequence

default PertinentDocumentsSequence ensurePertinentDocumentsSequence()

Adds a new Pertinent Documents Sequence (see PertinentDocumentsSequence) with initial capacity 1 (see ensurePertinentDocumentsSequence(int)) if it does not already exist.

Returns:

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

containsPertinentDocumentsSequence

default boolean containsPertinentDocumentsSequence()

Returns:

whether it contains the Pertinent Documents Sequence (see PertinentDocumentsSequence)

removePertinentDocumentsSequence

default void removePertinentDocumentsSequence()

Removes the Pertinent Documents Sequence (see PertinentDocumentsSequence