Package nzilbb.labbcat.server.db

Class ResultSeries

java.lang.Object

nzilbb.labbcat.server.db.ResultSeries

All Implemented Interfaces:

Spliterator<nzilbb.ag.Graph>, nzilbb.util.MonitorableSeries<nzilbb.ag.Graph>, nzilbb.util.MonitorableTask

public class ResultSeries
extends Object
implements nzilbb.util.MonitorableSeries<nzilbb.ag.Graph>

An implementation of Spliterator<Graph> that enumerates fragments corresponding to a search result set.

Author:

Robert Fromont robert@fromont.net.nz

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T extends Object,T_CONS extends Object,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary

Constructors

Constructor	Description
ResultSeries(long search_id, SqlGraphStore store, String[] layers)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels spliteration; the next call to tryAdvance will return false.
int	characteristics()
long	estimateSize()	Counts the elements in the series, if possible.
void	finalize()	Finalize method called by the garbage collector.
String[]	getLayers()	Getter for layers: Layers to load into the fragments.
Integer	getPercentComplete()	Determines how far through the serialization is.
boolean	getPrefixNames()	Getter for prefixNames: Whether to prefix fragment names with a numeric serial number or not.
boolean	getRunning()	Getter for running: Whether the task is currently running.
long	getSearchId()	Getter for searchId: result.search_id key value.
SqlGraphStore	getStore()	Getter for store: The graph store object.
boolean	getTagTarget()	Getter for tagTarget: Whether to add an tag identifying the target annotation or not.
boolean	hasMoreElements()	Tests if this enumeration contains more elements.
ResultSeries	setLayers(String[] newLayers)	Setter for layers: Layers to load into the fragments.
ResultSeries	setPrefixNames(boolean newPrefixNames)	Setter for prefixNames: Whether to prefix fragment names with a numeric serial number or not.
void	setRunning(boolean newRunning)	Setter for running: Whether the task is currently running.
ResultSeries	setSearchId(long newSearchId)	Setter for searchId: result.search_id key value.
ResultSeries	setStore(SqlGraphStore newStore)	Setter for store: The graph store object.
ResultSeries	setTagTarget(boolean newTagTarget)	Setter for tagTarget: Whether to add an tag identifying the target annotation or not.
boolean	tryAdvance(Consumer<? super nzilbb.ag.Graph> action)	Returns the next element of this enumeration if this enumeration object has at least one more element to provide.
Spliterator<nzilbb.ag.Graph>	trySplit()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nzilbb.util.MonitorableTask

getStatus, getTaskId

Methods inherited from interface java.util.Spliterator

forEachRemaining, getComparator, getExactSizeIfKnown, hasCharacteristics

Constructor Detail

ResultSeries

public ResultSeries(long search_id,
                    SqlGraphStore store,
                    String[] layers)
             throws SQLException

Constructor.

Throws:

SQLException - If an error occurs retrieving results.

Method Detail

getRunning

public boolean getRunning()

Getter for running: Whether the task is currently running.

Specified by:

getRunning in interface nzilbb.util.MonitorableTask

Returns:

Whether the task is currently running.

setRunning

public void setRunning(boolean newRunning)

Setter for running: Whether the task is currently running.

Parameters:

newRunning - Whether the task is currently running.

getStore

public SqlGraphStore getStore()

Getter for store: The graph store object.

Returns:

The graph store object.

setStore

public ResultSeries setStore(SqlGraphStore newStore)

Setter for store: The graph store object.

Parameters:

newStore - The graph store object.

getSearchId

public long getSearchId()

Getter for searchId: result.search_id key value.

Returns:

result.search_id key value.

setSearchId

public ResultSeries setSearchId(long newSearchId)

Setter for searchId: result.search_id key value.

Parameters:

newSearchId - result.search_id key value.

getLayers

public String[] getLayers()

Getter for layers: Layers to load into the fragments.

Returns:

Layers to load into the fragments.

setLayers

public ResultSeries setLayers(String[] newLayers)

Setter for layers: Layers to load into the fragments.

Parameters:

newLayers - Layers to load into the fragments.

getPrefixNames

public boolean getPrefixNames()

Getter for prefixNames: Whether to prefix fragment names with a numeric serial number or not.

Returns:

Whether to prefix fragment names with a numeric serial number or not.

setPrefixNames

public ResultSeries setPrefixNames(boolean newPrefixNames)

Setter for prefixNames: Whether to prefix fragment names with a numeric serial number or not.

Parameters:

newPrefixNames - Whether to prefix fragment names with a numeric serial number or not.

getTagTarget

public boolean getTagTarget()

Getter for tagTarget: Whether to add an tag identifying the target annotation or not.

Returns:

Whether to add an tag identifying the target annotation or not.

setTagTarget

public ResultSeries setTagTarget(boolean newTagTarget)

Setter for tagTarget: Whether to add an tag identifying the target annotation or not.

Parameters:

newTagTarget - Whether to add an tag identifying the target annotation or not.

finalize

public void finalize()

Finalize method called by the garbage collector.

This implementation ensures SQL resources are disposed of.

characteristics

public int characteristics()

Specified by:

characteristics in interface Spliterator<nzilbb.ag.Graph>

hasMoreElements

public boolean hasMoreElements()

Tests if this enumeration contains more elements.

tryAdvance

public boolean tryAdvance(Consumer<? super nzilbb.ag.Graph> action)

Returns the next element of this enumeration if this enumeration object has at least one more element to provide.

Specified by:

tryAdvance in interface Spliterator<nzilbb.ag.Graph>

estimateSize

public long estimateSize()

Counts the elements in the series, if possible.

Specified by:

estimateSize in interface Spliterator<nzilbb.ag.Graph>

Returns:

The number of elements in the series, or null if the number is unknown.

trySplit

public Spliterator<nzilbb.ag.Graph> trySplit()

Specified by:

trySplit in interface Spliterator<nzilbb.ag.Graph>

getPercentComplete

public Integer getPercentComplete()

Determines how far through the serialization is.

Specified by:

getPercentComplete in interface nzilbb.util.MonitorableTask

Returns:

An integer between 0 and 100 (inclusive), or null if progress can not be calculated.

cancel

public void cancel()

Cancels spliteration; the next call to tryAdvance will return false.

Specified by:

cancel in interface nzilbb.util.MonitorableTask