ResultSetConsumer (Vitro API 1.15.0 API)

java.lang.Object
- edu.cornell.mannlib.vitro.webapp.rdfservice.ResultSetConsumer

Direct Known Subclasses:

ResultSetConsumer.Chaining, ResultSetConsumer.HasResult
```
public abstract class ResultSetConsumer
extends Object
```
Base class for creating consumers of ResultSets processQuerySolution MUST be overridden - it takes each QuerySolution in turn until the ResultSet is complete startProcessing and endProcessing may be overridden if the implementation needs to know when the processing starts, or when there are no more solutions left to process.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ResultSetConsumer.Chaining`	Helper implemenation of ResutSetConsumer that can be used to wrap another ResultSetConsumer - useful for filtering implementations
`static class`	`ResultSetConsumer.HasResult`	Helper implementation that allows you to find out simply if there were any results in the ResultSet

Constructor Summary

Constructors
Constructor Description

ResultSetConsumer()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`endProcessing()`	Method to notify the consumer that all QuerySolutions have been processed
`protected List<String>`	`getResultVars()`	Helper method to allow an implementation to get the var names from the resultset
`protected abstract void`	`processQuerySolution(org.apache.jena.query.QuerySolution qs)`	Method for processing each QuerySolution - must be overridden in each implementation
`void`	`processResultSet(org.apache.jena.query.ResultSet rs)`	Helper method that ensures the start / end processing is done correctly
`protected void`	`startProcessing()`	Method to notify the consumer that a ResultSet is valid and is about to be processed

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ResultSetConsumer
```
public ResultSetConsumer()
```
- Method Detail
  - processQuerySolution
```
protected abstract void processQuerySolution(org.apache.jena.query.QuerySolution qs)
```
    Method for processing each QuerySolution - must be overridden in each implementation
    
    Parameters:
    
    qs - - the current query solution
  - startProcessing
```
protected void startProcessing()
```
    Method to notify the consumer that a ResultSet is valid and is about to be processed
  - endProcessing
```
protected void endProcessing()
```
    Method to notify the consumer that all QuerySolutions have been processed
  - processResultSet
```
public void processResultSet(org.apache.jena.query.ResultSet rs)
```
    Helper method that ensures the start / end processing is done correctly
    
    Parameters:
    
    rs - - the ResultSet to process
  - getResultVars
```
protected final List<String> getResultVars()
```
    Helper method to allow an implementation to get the var names from the resultset
    
    Returns:
    
    list of result set var names