Package org.dcm4che.typeddicom.dataelements

Interface XDSRetrievalSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

InputInformationSequence.Item, OutputInformationSequence.Item, ReferencedPatientPhotoSequence.Item

Enclosing class:

XDSRetrievalSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "XDS Retrieval Sequence" (see XDSRetrievalSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XDSRetrievalSequence.Holder.Builder	builder()
static XDSRetrievalSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsXDSRetrievalSequence()
default XDSRetrievalSequence	ensureXDSRetrievalSequence()	Adds a new XDS Retrieval Sequence (see XDSRetrievalSequence) with initial capacity 1 (see ensureXDSRetrievalSequence(int)) if it does not already exist.
default XDSRetrievalSequence	ensureXDSRetrievalSequence(int initialCapacity)	Adds a new XDS Retrieval Sequence (see XDSRetrievalSequence) if it does not already exist.
default XDSRetrievalSequence	getXDSRetrievalSequence()
default XDSRetrievalSequence	newXDSRetrievalSequence(int initialCapacity)	Adds a new XDS Retrieval Sequence.
default void	removeXDSRetrievalSequence()	Removes the XDS Retrieval Sequence (see XDSRetrievalSequence
static XDSRetrievalSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the XDS Retrieval Sequence (see XDSRetrievalSequence)

Returns:

a wrapper object implementing the XDSRetrievalSequence.Holder interface.

builder

static XDSRetrievalSequence.Holder.Builder builder()

Returns:

a XDSRetrievalSequence.Holder.Builder to create XDS Retrieval Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a XDSRetrievalSequence.Holder.Builder to create XDS Retrieval Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getXDSRetrievalSequence

default XDSRetrievalSequence getXDSRetrievalSequence()

Returns:

the XDS Retrieval Sequence (see XDSRetrievalSequence)

newXDSRetrievalSequence

default XDSRetrievalSequence newXDSRetrievalSequence(int initialCapacity)

Adds a new XDS Retrieval Sequence. (see XDSRetrievalSequence)

Parameters:

initialCapacity - the initial capacity for the new XDS Retrieval Sequence

Returns:

the newly created XDSRetrievalSequence.

ensureXDSRetrievalSequence

default XDSRetrievalSequence ensureXDSRetrievalSequence(int initialCapacity)

Adds a new XDS Retrieval Sequence (see XDSRetrievalSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing XDS Retrieval Sequence (see XDSRetrievalSequence) or a new one with capacity initialCapacity.

ensureXDSRetrievalSequence

default XDSRetrievalSequence ensureXDSRetrievalSequence()

Adds a new XDS Retrieval Sequence (see XDSRetrievalSequence) with initial capacity 1 (see ensureXDSRetrievalSequence(int)) if it does not already exist.

Returns:

either the already existing XDS Retrieval Sequence (see XDSRetrievalSequence) or a new one with capacity 1.

containsXDSRetrievalSequence

default boolean containsXDSRetrievalSequence()

Returns:

whether it contains the XDS Retrieval Sequence (see XDSRetrievalSequence)

removeXDSRetrievalSequence

default void removeXDSRetrievalSequence()

Removes the XDS Retrieval Sequence (see XDSRetrievalSequence