Package org.dcm4che.typeddicom.dataelements

Interface InstitutionCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

VisitIdentificationModule

All Known Implementing Classes:

ApprovalSequence.Item, AsserterIdentificationSequence.Item, AssessmentRequesterSequence.Item, AuthorIdentificationSequence.Item, AuthorObserverSequence.Item, ConsultingPhysicianIdentificationSequence.Item, ContentCreatorIdentificationCodeSequence.Item, CustodialOrganizationSequence.Item, EquipmentAdministratorSequence.Item, InstitutionCodeSequence.SimpleHolder, IntendedRecipientsOfResultsIdentificationSequence.Item, InterlockResolutionUserSequence.Item, OperatorIdentificationSequence.Item, ParticipantSequence.Item, PerformingPhysicianIdentificationSequence.Item, PhysiciansOfRecordIdentificationSequence.Item, PhysiciansReadingStudyIdentificationSequence.Item, ReferringPhysicianIdentificationSequence.Item, RequestingPhysicianIdentificationSequence.Item, ScheduledPerformingPhysicianIdentificationSequence.Item, UnifiedProcedureStepIOD

Enclosing class:

InstitutionCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Institution Code Sequence" (see InstitutionCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InstitutionCodeSequence.Holder.Builder	builder()
static InstitutionCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsInstitutionCodeSequence()
default InstitutionCodeSequence	ensureInstitutionCodeSequence()	Adds a new Institution Code Sequence (see InstitutionCodeSequence) with initial capacity 1 (see ensureInstitutionCodeSequence(int)) if it does not already exist.
default InstitutionCodeSequence	ensureInstitutionCodeSequence(int initialCapacity)	Adds a new Institution Code Sequence (see InstitutionCodeSequence) if it does not already exist.
default InstitutionCodeSequence	getInstitutionCodeSequence()
default InstitutionCodeSequence	newInstitutionCodeSequence(int initialCapacity)	Adds a new Institution Code Sequence.
default void	removeInstitutionCodeSequence()	Removes the Institution Code Sequence (see InstitutionCodeSequence
static InstitutionCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Institution Code Sequence (see InstitutionCodeSequence)

Returns:

a wrapper object implementing the InstitutionCodeSequence.Holder interface.

builder

static InstitutionCodeSequence.Holder.Builder builder()

Returns:

a InstitutionCodeSequence.Holder.Builder to create Institution Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getInstitutionCodeSequence

default InstitutionCodeSequence getInstitutionCodeSequence()

Returns:

the Institution Code Sequence (see InstitutionCodeSequence)

newInstitutionCodeSequence

default InstitutionCodeSequence newInstitutionCodeSequence(int initialCapacity)

Adds a new Institution Code Sequence. (see InstitutionCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Institution Code Sequence

Returns:

the newly created InstitutionCodeSequence.

ensureInstitutionCodeSequence

default InstitutionCodeSequence ensureInstitutionCodeSequence(int initialCapacity)

Adds a new Institution Code Sequence (see InstitutionCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Institution Code Sequence (see InstitutionCodeSequence) or a new one with capacity initialCapacity.

ensureInstitutionCodeSequence

default InstitutionCodeSequence ensureInstitutionCodeSequence()

Adds a new Institution Code Sequence (see InstitutionCodeSequence) with initial capacity 1 (see ensureInstitutionCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Institution Code Sequence (see InstitutionCodeSequence) or a new one with capacity 1.

containsInstitutionCodeSequence

default boolean containsInstitutionCodeSequence()

Returns:

whether it contains the Institution Code Sequence (see InstitutionCodeSequence)

removeInstitutionCodeSequence

default void removeInstitutionCodeSequence()

Removes the Institution Code Sequence (see InstitutionCodeSequence