com.bigdata.bop.controller
Class NamedSolutionSetRef

java.lang.Object
  com.bigdata.bop.controller.NamedSolutionSetRef

All Implemented Interfaces:

Serializable

public class NamedSolutionSetRef
extends Object
implements Serializable

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.

Version:

$Id: NamedSolutionSetRef.java 5716 2011-11-21 20:47:10Z thompsonbry $

Author:

Bryan Thompson

See Also:

Serialized Form

Field Summary

IVariable[]	joinVars The join variables (required, but may be an empty array).
String	namedSet The application level name for the named solution set.
UUID	queryId The UUID of the IRunningQuery which generated the named solution set.

Constructor Summary

NamedSolutionSetRef(UUID queryId, String namedSet, IVariable[] joinVars)

Method Summary

boolean	equals(Object o)
int	hashCode()
String	toString() Return a human readable representation which can be decoded by valueOf(String).
static NamedSolutionSetRef	valueOf(String s) Parses the toString() representation, returning an instance of this class.

Methods inherited from class java.lang.Object

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

Field Detail

queryId

public final UUID queryId

The UUID of the IRunningQuery which generated the named solution set. This is where you need to look to find the data.

namedSet

public final String namedSet

The application level name for the named solution set.

joinVars

public final IVariable[] joinVars

The join variables (required, but may be an empty array).

Constructor Detail

NamedSolutionSetRef

public NamedSolutionSetRef(UUID queryId,
                           String namedSet,
                           IVariable[] joinVars)

Parameters:

queryId - The UUID of the IRunningQuery where you need to look to find the data (required).

namedSet - The application level name for the named solution set (required).

joinVars - The join variables (required, but may be an empty array).

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

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

Overrides:

toString in class Object

valueOf

public static NamedSolutionSetRef valueOf(String s)

Parses the toString() representation, returning an instance of this class.