com.bigdata.rdf.sparql.ast.ssets

Interface ISolutionSetManager

All Known Implementing Classes:

SolutionSetManager

public interface ISolutionSetManager

A management interface for named solution sets.

Note: This is an internal interface that may evolve substantially.

Version:

$Id$

Author:

Bryan Thompson

See Also:

SPARQL Update , SPARQL UPDATE for NAMED SOLUTION SETS

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAllSolutions() Clear all named solution sets.
boolean	clearSolutions(String solutionSet) Clear the specified named solution set.
void	close() Shutdown.
void	createSolutions(String solutionSet, ISPO[] params) Create a named solution set.
boolean	existsSolutions(String solutionSet) Return true iff a named solution set exists.
ICloseableIterator<IBindingSet[]>	getSolutions(String solutionSet) Read the solutions from a named solution set.
ISolutionSetStats	getSolutionSetStats(String solutionSet) Return computed statistics for a named solution set.
void	init() One time initialization.
void	putSolutions(String solutionSet, ICloseableIterator<IBindingSet[]> src) Save the solutions into a named solution set.

Method Detail

init

void init()

One time initialization.

close

void close()

Shutdown.

clearSolutions

boolean clearSolutions(String solutionSet)

Clear the specified named solution set.

Parameters:

solutionSet - The name of the solution set.

Returns:

true iff a solution set by that name existed and was cleared.

clearAllSolutions

void clearAllSolutions()

Clear all named solution sets.

createSolutions

void createSolutions(String solutionSet,
                   ISPO[] params)

Create a named solution set.

Parameters:

solutionSet - The name of the solution set.

params - The configuration parameters (optional).

Throws:

RuntimeException - if a solution set exists for that name.

putSolutions

void putSolutions(String solutionSet,
                ICloseableIterator<IBindingSet[]> src)

Save the solutions into a named solution set. If there is an existing solution set having that name, then its solutions will be replaced by the new solutions (replace not append).

Parameters:

solutionSet - The name of the solution set.

src - The solutions.

getSolutions

ICloseableIterator<IBindingSet[]> getSolutions(String solutionSet)

Read the solutions from a named solution set.

Parameters:

solutionSet - The name of the solution set.

Returns:

An iterator from which the solutions may be drained.

Throws:

IllegalStateException - if no solution set with that name exists.

getSolutionSetStats

ISolutionSetStats getSolutionSetStats(String solutionSet)

Return computed statistics for a named solution set.

Parameters:

solutionSet - The name of the solution set.

Returns:

The statistics -or- null if there is no such named solution set.

existsSolutions

boolean existsSolutions(String solutionSet)

Return true iff a named solution set exists.

Parameters:

solutionSet - The name of the solution set.

Returns:

true iff a solution set having that name exists.