org.modeshape.graph.request
Class FullTextSearchRequest

java.lang.Object
  extended by org.modeshape.graph.request.Request
      extended by org.modeshape.graph.request.SearchRequest
          extended by org.modeshape.graph.request.FullTextSearchRequest
All Implemented Interfaces:
Serializable

public class FullTextSearchRequest
extends SearchRequest

A Request to perform a full-text search on a graph.

See Also:
Serialized Form

Constructor Summary
FullTextSearchRequest(String fullTextSearch, String workspace, int maxResults, int offset)
          Create a new request to execute the supplied query against the name workspace.
 
Method Summary
 boolean equals(Object obj)
          
 String expression()
          Get the full-text search expression that is to be executed.
 QueryResults.Columns getResultColumns()
          Get the specification of the columns for the results.
 int hashCode()
          
 int maxResults()
          Get the maximum number of results that should be returned.
 int offset()
          Get the number of initial search results that should be excluded from the tuples included on this request.
 void setResults(QueryResults.Columns resultColumns, List<Object[]> tuples, QueryResults.Statistics statistics)
          Set the results for this request.
 String toString()
          
 String workspace()
          Get the name of the workspace in which the node exists.
 
Methods inherited from class org.modeshape.graph.request.SearchRequest
cancel, getStatistics, getTuples, isReadOnly
 
Methods inherited from class org.modeshape.graph.request.Request
freeze, getError, hasError, isCancelled, isFrozen, setError, setLatchForFreezing
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FullTextSearchRequest

public FullTextSearchRequest(String fullTextSearch,
                             String workspace,
                             int maxResults,
                             int offset)
Create a new request to execute the supplied query against the name workspace.

Parameters:
fullTextSearch - the full-text search to be performed; may not be null
workspace - the name of the workspace to be queried
maxResults - the maximum number of results that are to be returned; always positive
offset - the number of initial results to skip, or 0 if the first results are to be returned
Throws:
IllegalArgumentException - if the query or workspace name is null, if the maxResults is not positive, or if the offset is negative
Method Detail

expression

public String expression()
Get the full-text search expression that is to be executed.

Returns:
the full-text search expression; never null and never empty

workspace

public String workspace()
Get the name of the workspace in which the node exists.

Returns:
the name of the workspace; never null

maxResults

public int maxResults()
Get the maximum number of results that should be returned.

Returns:
the maximum number of results that are to be returned; always positive

offset

public int offset()
Get the number of initial search results that should be excluded from the tuples included on this request.

Returns:
the number of initial results to skip, or 0 if the first results are to be returned

hashCode

public int hashCode()

Overrides:
hashCode in class Object
See Also:
Object.hashCode()

getResultColumns

public QueryResults.Columns getResultColumns()
Get the specification of the columns for the results.

Returns:
the column specifications; never null

setResults

public void setResults(QueryResults.Columns resultColumns,
                       List<Object[]> tuples,
                       QueryResults.Statistics statistics)
Set the results for this request.

Parameters:
resultColumns - the definition of the result columns
tuples - the result values
statistics - the statistics, or null if there are none

equals

public boolean equals(Object obj)

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

toString

public String toString()

Overrides:
toString in class Object
See Also:
Object.toString()


Copyright © 2008-2010 JBoss, a division of Red Hat. All Rights Reserved.