com.bigdata.bop

Class NamedSolutionSetRef

java.lang.Object

com.bigdata.bop.NamedSolutionSetRef

All Implemented Interfaces:

INamedSolutionSetRef, Serializable

public class NamedSolutionSetRef
extends Object
implements INamedSolutionSetRef

Class models the information which uniquely describes a named solution set. The "name" is comprised of the following components:

queryId

The UUID of the query which generated the named solution set. This provides the scope for the named solution set. It is used to (a) locate the data; and (b) release the data when the query goes out of scope.

namedSet

The "name" of the solution set as given in the query. The name is not a sufficient identifier since the same solution set name may be used in different queries and with different join variables.

joinVars[]

The ordered array of the join variable. This serves to differentiate among named solution sets having the same data but different join variables.

Together, these components provide for a name that is unique within the scope of a query.

Author:

Bryan Thompson

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
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.
int	hashCode()
String	toString() Return a human readable representation which can be decoded by NamedSolutionSetRefUtility.valueOf(String).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getQueryId

public final UUID getQueryId()

Description copied from interface: INamedSolutionSetRef

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.

Specified by:

getQueryId in interface INamedSolutionSetRef

getNamespace

public String getNamespace()

Description copied from interface: INamedSolutionSetRef

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

Specified by:

getNamespace in interface INamedSolutionSetRef

See Also:

INamedSolutionSetRef.getQueryId(), INamedSolutionSetRef.getTimestamp();

getTimestamp

public long getTimestamp()

Description copied from interface: INamedSolutionSetRef

The timestamp associated with the KB view.

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

Specified by:

getTimestamp in interface INamedSolutionSetRef

getLocalName

public final String getLocalName()

Description copied from interface: INamedSolutionSetRef

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

Specified by:

getLocalName in interface INamedSolutionSetRef

getJoinVars

public final IVariable[] getJoinVars()

Description copied from interface: INamedSolutionSetRef

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).

Specified by:

getJoinVars in interface INamedSolutionSetRef

getFQN

public String getFQN()

Description copied from interface: INamedSolutionSetRef

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 INamedSolutionSetRef.getQueryId() (identifying the query) and the INamedSolutionSetRef object together provide the equivalent of a fully qualified name.

Specified by:

getFQN in interface INamedSolutionSetRef

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Description copied from interface: INamedSolutionSetRef

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

Specified by:

toString in interface INamedSolutionSetRef

Overrides:

toString in class Object