Package org.dcm4che.typeddicom.dataelements

Interface ProposedStudySequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

BasicFilmSessionRelationshipModule

All Known Implementing Classes:

BasicFilmSessionRelationshipModule.SimpleWrapper, FilmSessionIOD

Enclosing class:

ProposedStudySequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Proposed Study Sequence" (see ProposedStudySequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ProposedStudySequence.Holder.Builder	builder()
static ProposedStudySequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsProposedStudySequence()
default ProposedStudySequence	ensureProposedStudySequence()	Adds a new Proposed Study Sequence (see ProposedStudySequence) with initial capacity 1 (see ensureProposedStudySequence(int)) if it does not already exist.
default ProposedStudySequence	ensureProposedStudySequence(int initialCapacity)	Adds a new Proposed Study Sequence (see ProposedStudySequence) if it does not already exist.
default ProposedStudySequence	getProposedStudySequence()
default ProposedStudySequence	newProposedStudySequence(int initialCapacity)	Adds a new Proposed Study Sequence.
default void	removeProposedStudySequence()	Removes the Proposed Study Sequence (see ProposedStudySequence
static ProposedStudySequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Proposed Study Sequence (see ProposedStudySequence)

Returns:

a wrapper object implementing the ProposedStudySequence.Holder interface.

builder

static ProposedStudySequence.Holder.Builder builder()

Returns:

a ProposedStudySequence.Holder.Builder to create Proposed Study Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getProposedStudySequence

default ProposedStudySequence getProposedStudySequence()

Returns:

the Proposed Study Sequence (see ProposedStudySequence)

newProposedStudySequence

default ProposedStudySequence newProposedStudySequence(int initialCapacity)

Adds a new Proposed Study Sequence. (see ProposedStudySequence)

Parameters:

initialCapacity - the initial capacity for the new Proposed Study Sequence

Returns:

the newly created ProposedStudySequence.

ensureProposedStudySequence

default ProposedStudySequence ensureProposedStudySequence(int initialCapacity)

Adds a new Proposed Study Sequence (see ProposedStudySequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Proposed Study Sequence (see ProposedStudySequence) or a new one with capacity initialCapacity.

ensureProposedStudySequence

default ProposedStudySequence ensureProposedStudySequence()

Adds a new Proposed Study Sequence (see ProposedStudySequence) with initial capacity 1 (see ensureProposedStudySequence(int)) if it does not already exist.

Returns:

either the already existing Proposed Study Sequence (see ProposedStudySequence) or a new one with capacity 1.

containsProposedStudySequence

default boolean containsProposedStudySequence()

Returns:

whether it contains the Proposed Study Sequence (see ProposedStudySequence)

removeProposedStudySequence

default void removeProposedStudySequence()

Removes the Proposed Study Sequence (see ProposedStudySequence