org.apache.nifi.provenance

Class StandardQueryResult

java.lang.Object

org.apache.nifi.provenance.StandardQueryResult

All Implemented Interfaces:

ProgressiveResult, QueryResult

public class StandardQueryResult
extends java.lang.Object
implements QueryResult, ProgressiveResult

Field Summary

Fields

Modifier and Type	Field and Description
static int	TTL

Constructor Summary

Constructors

Constructor and Description
StandardQueryResult(Query query, int numSteps)

Method Summary

Modifier and Type	Method and Description
boolean	awaitCompletion(long time, java.util.concurrent.TimeUnit unit)
java.lang.String	getError()
java.util.Date	getExpiration()
java.util.List<ProvenanceEventRecord>	getMatchingEvents()
int	getPercentComplete()
long	getQueryTime()
long	getTotalHitCount()
boolean	isFinished()
void	setError(java.lang.String error)
void	update(java.util.Collection<ProvenanceEventRecord> newEvents, long totalHits)

Methods inherited from class java.lang.Object

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

Field Detail

TTL

public static final int TTL

Constructor Detail

StandardQueryResult

public StandardQueryResult(Query query,
                           int numSteps)

Method Detail

getMatchingEvents

public java.util.List<ProvenanceEventRecord> getMatchingEvents()

Specified by:

getMatchingEvents in interface QueryResult

Returns:

the Provenance events that match the query (up to the limit specified in the query)

getTotalHitCount

public long getTotalHitCount()

Specified by:

getTotalHitCount in interface ProgressiveResult

Specified by:

getTotalHitCount in interface QueryResult

Returns:

the total number of Provenance Events that hit

getQueryTime

public long getQueryTime()

Specified by:

getQueryTime in interface QueryResult

Returns:

the number of milliseconds the query took to run

getExpiration

public java.util.Date getExpiration()

Specified by:

getExpiration in interface QueryResult

Returns:

the date at which this QueryResult will expire

getError

public java.lang.String getError()

Specified by:

getError in interface QueryResult

Returns:

If an error occurred while computing the lineage, this will return the serialized error; otherwise, returns null

getPercentComplete

public int getPercentComplete()

Specified by:

getPercentComplete in interface QueryResult

Returns:

an integer between 0 and 100 (inclusive) that indicates what percentage of completion the query has reached

isFinished

public boolean isFinished()

Specified by:

isFinished in interface ProgressiveResult

Specified by:

isFinished in interface QueryResult

Returns:

Indicates whether or not the query has finished running

setError

public void setError(java.lang.String error)

Specified by:

setError in interface ProgressiveResult

update

public void update(java.util.Collection<ProvenanceEventRecord> newEvents,
                   long totalHits)

Specified by:

update in interface ProgressiveResult

awaitCompletion

public boolean awaitCompletion(long time,
                               java.util.concurrent.TimeUnit unit)
                        throws java.lang.InterruptedException

Specified by:

awaitCompletion in interface QueryResult

Throws:

java.lang.InterruptedException