| com.jofti.api.IndexQuery
All known Subclasses: com.jofti.query.EJBQuery, com.jofti.query.namespace.MatchNSInQuery, com.jofti.query.SQLQuery, com.jofti.query.MatchInQuery, com.jofti.parser.SQLQueryWrapper, com.jofti.query.MatchNotQuery, com.jofti.parser.ParsedQueryWrapper, com.jofti.parser.ParsedQuery, com.jofti.query.namespace.MatchNSNotQuery, com.jofti.query.MatchQuery, com.jofti.query.Query, com.jofti.query.namespace.MatchNSQuery, com.jofti.query.namespace.MatchNSRangeQuery, com.jofti.query.MatchRangeQuery,
| IndexQuery | | public interface IndexQuery (Code) | | Root interface for query objects. All IndexQueries will implement this interface, but not all are required
to provide implementations of the optional parameter setting methods.
author:
Steve Woodcock
version:
1.7 |
| setFirstResult | | public IndexQuery setFirstResult(int firstResult)(Code) | |
Sets the first result number to be returned. If this is used in conjunction with maxResults then a paging type
mechanism can be emulated (providing the results are ordered). A negative value will result in a runtimeException and setting the value
larger than the number of results will result in zero results returned.
The method returns the IndexQuery in order to allow method chaining for parameter setting.
Parameters:
firstResult - - the position of the first result - this is 0 indexed. - The indexQuery that the parameter was set on. |
| setMaxResults | | public IndexQuery setMaxResults(int maxResults)(Code) | |
Sets a maximum number of results to return in the query. If the results are not ordered then
repeated calling of the method could return different results irrespective of data changes.
When ordering is set repeated calls with this value set will return the same results providing
that the data has not changed. However, in order to provide ordering the full result set must
be evaluated and are therefore loaded into memory. The results falling outside the return range will then be discarded.
A negative value will return a runtime IllegalArgumentException. Zero is equivalent to all results. Setting the value to more than
the number of results found will results in all results being returned.
The method returns the IndexQuery in order to allow method chaining for parameter setting.
Parameters:
maxResults - - the maximum number of results to return. - The indexQuery that the parameter was set on. |
| setParameter | | public IndexQuery setParameter(String name, Object value)(Code) | |
Sets a parameter on a Query by name. The name should match a String representation of the
parameter in the query implementation. The format of the name is defined by the type of query.
The method returns the IndexQuery in order to allow method chaining for parameter setting.
Parameters:
name - - the name for the parameter.
Parameters:
value - - the Object that is used to bind to the parameter. - The indexQuery that the parameter was set on. |
| setParameter | | public IndexQuery setParameter(int position, Object value)(Code) | |
Sets a parameter on a Query by name. The name should match the numeric position of the
parameter in the query implmentation. The format of the name is defined by the type of query.
The method returns the IndexQuery in order to allow method chaining for parameter setting.
Parameters:
position - - the position for the parameter.
Parameters:
value - - the Object that is used to bind to the parameter. - The indexQuery that the parameter was set on. |
|
|