Package org.dcm4che.typeddicom.dataelements

Interface PatientSpecificationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

PatientSpecificationModule

All Known Implementing Classes:

CTDefinedProcedureProtocolIOD, PatientSpecificationModule.SimpleWrapper, XADefinedProcedureProtocolIOD

Enclosing class:

PatientSpecificationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Patient Specification Sequence" (see PatientSpecificationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PatientSpecificationSequence.Holder.Builder	builder()
static PatientSpecificationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPatientSpecificationSequence()
default PatientSpecificationSequence	ensurePatientSpecificationSequence()	Adds a new Patient Specification Sequence (see PatientSpecificationSequence) with initial capacity 1 (see ensurePatientSpecificationSequence(int)) if it does not already exist.
default PatientSpecificationSequence	ensurePatientSpecificationSequence(int initialCapacity)	Adds a new Patient Specification Sequence (see PatientSpecificationSequence) if it does not already exist.
default PatientSpecificationSequence	getPatientSpecificationSequence()
default PatientSpecificationSequence	newPatientSpecificationSequence(int initialCapacity)	Adds a new Patient Specification Sequence.
default void	removePatientSpecificationSequence()	Removes the Patient Specification Sequence (see PatientSpecificationSequence
static PatientSpecificationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Patient Specification Sequence (see PatientSpecificationSequence)

Returns:

a wrapper object implementing the PatientSpecificationSequence.Holder interface.

builder

static PatientSpecificationSequence.Holder.Builder builder()

Returns:

a PatientSpecificationSequence.Holder.Builder to create Patient Specification Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPatientSpecificationSequence

default PatientSpecificationSequence getPatientSpecificationSequence()

Returns:

the Patient Specification Sequence (see PatientSpecificationSequence)

newPatientSpecificationSequence

default PatientSpecificationSequence newPatientSpecificationSequence(int initialCapacity)

Adds a new Patient Specification Sequence. (see PatientSpecificationSequence)

Parameters:

initialCapacity - the initial capacity for the new Patient Specification Sequence

Returns:

the newly created PatientSpecificationSequence.

ensurePatientSpecificationSequence

default PatientSpecificationSequence ensurePatientSpecificationSequence(int initialCapacity)

Adds a new Patient Specification Sequence (see PatientSpecificationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Patient Specification Sequence (see PatientSpecificationSequence) or a new one with capacity initialCapacity.

ensurePatientSpecificationSequence

default PatientSpecificationSequence ensurePatientSpecificationSequence()

Adds a new Patient Specification Sequence (see PatientSpecificationSequence) with initial capacity 1 (see ensurePatientSpecificationSequence(int)) if it does not already exist.

Returns:

either the already existing Patient Specification Sequence (see PatientSpecificationSequence) or a new one with capacity 1.

containsPatientSpecificationSequence

default boolean containsPatientSpecificationSequence()

Returns:

whether it contains the Patient Specification Sequence (see PatientSpecificationSequence)

removePatientSpecificationSequence

default void removePatientSpecificationSequence()

Removes the Patient Specification Sequence (see PatientSpecificationSequence