net.fortytwo.stream

Class BasicSubscription<C,Q,S>

java.lang.Object

net.fortytwo.stream.BasicSubscription<C,Q,S>

Type Parameters:

Q - the native query type

C - the constraint type

S - the solution type

All Implemented Interfaces:

Subscription

public class BasicSubscription<C,Q,S>
extends java.lang.Object
implements Subscription

An object which associates a query with a handler for the query's results

Author:

Joshua Shinavier (http://fortytwo.net)

Constructor Summary

Constructors

Constructor and Description
BasicSubscription(C sparqlQuery, Q query, java.util.function.BiConsumer<S,java.lang.Long> solutionConsumer, BasicStreamProcessor<?,C,Q,?,S> processor)

Method Summary

Modifier and Type	Method and Description
void	cancel() Marks this subscription as inactive, so that the query no longer receives results
C	getConstraint()
java.lang.String	getId()
Q	getQuery()
java.util.function.BiConsumer<S,java.lang.Long>	getSolutionConsumer()
boolean	isActive()
boolean	renew(int ttl) Renews the subscription for another ttl milliseconds (or indefinitely, if ttl=0), provided the renewal operation is accepted by the query engine.
void	setQuery(Q query)
void	setSolutionConsumer(java.util.function.BiConsumer<S,java.lang.Long> solutionConsumer)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicSubscription

public BasicSubscription(C sparqlQuery,
                         Q query,
                         java.util.function.BiConsumer<S,java.lang.Long> solutionConsumer,
                         BasicStreamProcessor<?,C,Q,?,S> processor)

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface Subscription

Returns:

a globally unique id for this subscription

isActive

public boolean isActive()

Specified by:

isActive in interface Subscription

Returns:

whether this subscription is still registered with the StreamProcessor (occupying resources and potentially receiving and handling query results)

cancel

public void cancel()
            throws java.io.IOException

Description copied from interface: Subscription

Marks this subscription as inactive, so that the query no longer receives results

Specified by:

cancel in interface Subscription

Throws:

java.io.IOException - if there is a problem communicating with this query engine (for example, if there are network operations involved)

renew

public boolean renew(int ttl)
              throws java.io.IOException

Description copied from interface: Subscription

Renews the subscription for another ttl milliseconds (or indefinitely, if ttl=0), provided the renewal operation is accepted by the query engine.

Specified by:

renew in interface Subscription

Parameters:

ttl - the new time-to-live in seconds, or 0 for infinite time-to-live

Returns:

whether the subscription was successfully renewed

Throws:

java.io.IOException - if there is a problem communicating with this query engine (for example, if there are network operations involved)

getConstraint

public C getConstraint()

Returns:

the SPARQL query which has been registered in the StreamProcessor

getQuery

public Q getQuery()

Returns:

the graph pattern which has been indexed in the forward-chaining tuple store implementation

getSolutionConsumer

public java.util.function.BiConsumer<S,java.lang.Long> getSolutionConsumer()

Returns:

the handler for the query's results

setQuery

public void setQuery(Q query)

setSolutionConsumer

public void setSolutionConsumer(java.util.function.BiConsumer<S,java.lang.Long> solutionConsumer)