Package org.dcm4che.typeddicom.dataelements

Interface BiopsyTargetSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MammographyImageModule

All Known Implementing Classes:

DigitalMammographyXRayImageIOD, MammographyImageModule.SimpleWrapper

Enclosing class:

BiopsyTargetSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Biopsy Target Sequence" (see BiopsyTargetSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BiopsyTargetSequence.Holder.Builder	builder()
static BiopsyTargetSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBiopsyTargetSequence()
default BiopsyTargetSequence	ensureBiopsyTargetSequence()	Adds a new Biopsy Target Sequence (see BiopsyTargetSequence) with initial capacity 1 (see ensureBiopsyTargetSequence(int)) if it does not already exist.
default BiopsyTargetSequence	ensureBiopsyTargetSequence(int initialCapacity)	Adds a new Biopsy Target Sequence (see BiopsyTargetSequence) if it does not already exist.
default BiopsyTargetSequence	getBiopsyTargetSequence()
default BiopsyTargetSequence	newBiopsyTargetSequence(int initialCapacity)	Adds a new Biopsy Target Sequence.
default void	removeBiopsyTargetSequence()	Removes the Biopsy Target Sequence (see BiopsyTargetSequence
static BiopsyTargetSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Biopsy Target Sequence (see BiopsyTargetSequence)

Returns:

a wrapper object implementing the BiopsyTargetSequence.Holder interface.

builder

static BiopsyTargetSequence.Holder.Builder builder()

Returns:

a BiopsyTargetSequence.Holder.Builder to create Biopsy Target Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a BiopsyTargetSequence.Holder.Builder to create Biopsy Target Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getBiopsyTargetSequence

default BiopsyTargetSequence getBiopsyTargetSequence()

Returns:

the Biopsy Target Sequence (see BiopsyTargetSequence)

newBiopsyTargetSequence

default BiopsyTargetSequence newBiopsyTargetSequence(int initialCapacity)

Adds a new Biopsy Target Sequence. (see BiopsyTargetSequence)

Parameters:

initialCapacity - the initial capacity for the new Biopsy Target Sequence

Returns:

the newly created BiopsyTargetSequence.

ensureBiopsyTargetSequence

default BiopsyTargetSequence ensureBiopsyTargetSequence(int initialCapacity)

Adds a new Biopsy Target Sequence (see BiopsyTargetSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Biopsy Target Sequence (see BiopsyTargetSequence) or a new one with capacity initialCapacity.

ensureBiopsyTargetSequence

default BiopsyTargetSequence ensureBiopsyTargetSequence()

Adds a new Biopsy Target Sequence (see BiopsyTargetSequence) with initial capacity 1 (see ensureBiopsyTargetSequence(int)) if it does not already exist.

Returns:

either the already existing Biopsy Target Sequence (see BiopsyTargetSequence) or a new one with capacity 1.

containsBiopsyTargetSequence

default boolean containsBiopsyTargetSequence()

Returns:

whether it contains the Biopsy Target Sequence (see BiopsyTargetSequence)

removeBiopsyTargetSequence

default void removeBiopsyTargetSequence()

Removes the Biopsy Target Sequence (see BiopsyTargetSequence