com.bigdata.bop.controller

Interface INamedSolutionSetRef

All Superinterfaces:

Serializable

All Known Implementing Classes:

NamedSolutionSetRef

public interface INamedSolutionSetRef
extends Serializable

An interface specifying the information required to locate a named solution set.

Note: There are two basic ways to locate named solution sets. Either they are attached to the IQueryAttributes of an IRunningQuery (query local) -or- they are located using the namespace and timestamp of an MVCC view (this works for both cached and durable named solution sets). Either getQueryId() will be non- null or getNamespace() will be non-null , but not both.

Author:

Bryan Thompson

Method Summary

Methods

Modifier and Type	Method and Description
String	getFQN() Return the fully qualified name of the named solution set.
IVariable[]	getJoinVars() The ordered set of variables that specifies the ordered set of components in the key for the desired index over the named solution set (required, but may be an empty array).
String	getLocalName() The application level name for the named solution set (as used in a SPARQL query or update operation).
String	getNamespace() The namespace associated with the KB view -or- null if the named solution set is attached to an IRunningQuery.
UUID	getQueryId() The UUID of the IRunningQuery which generated the named solution set.
long	getTimestamp() The timestamp associated with the KB view.
String	toString() Return a human readable representation which can be decoded by NamedSolutionSetRefUtility.valueOf(String).

Method Detail

getQueryId

UUID getQueryId()

The UUID of the IRunningQuery which generated the named solution set. When non-null, this is where you need to look to find the data.

getNamespace

String getNamespace()

The namespace associated with the KB view -or- null if the named solution set is attached to an IRunningQuery.

See Also:

getQueryId(), getTimestamp();

getTimestamp

long getTimestamp()

The timestamp associated with the KB view.

Note: This MUST be ignored if getNamespace() returns null.

getLocalName

String getLocalName()

The application level name for the named solution set (as used in a SPARQL query or update operation).

getFQN

String getFQN()

Return the fully qualified name of the named solution set. This is the name that is used to resolve the named solution set against a durable store or cache.

Note: When the named solution set is attached to an IQueryAttributes, the INamedSolutionSetRef itself is used as the key into the IQueryAttributes. In this case, the combination of the getQueryId() (identifying the query) and the INamedSolutionSetRef object together provide the equivalent of a fully qualified name.

getJoinVars

IVariable[] getJoinVars()

The ordered set of variables that specifies the ordered set of components in the key for the desired index over the named solution set (required, but may be an empty array).

toString

String toString()

Return a human readable representation which can be decoded by NamedSolutionSetRefUtility.valueOf(String).

Overrides:

toString in class Object