| org.mmbase.storage.search.SearchQuery
All known Subclasses: org.mmbase.storage.search.implementation.NodeSearchQuery, org.mmbase.storage.search.implementation.ModifiableQuery, org.mmbase.storage.search.implementation.BasicSearchQuery,
| SearchQuery | | public interface SearchQuery extends Cacheable(Code) | | Encapsulates a request for a search of the object cloud.
This corresponds to a SELECT query in SQL syntax.
author:
Rob van Maris
version:
$Id: SearchQuery.java,v 1.6 2007/12/06 08:13:36 michiel Exp $
since:
MMBase-1.7 |
| Method Summary | |
| public boolean | equals(Object obj)
Compares this query to the specified object. | | Constraint | getConstraint()
Gets the constraints on the search results. | | List<StepField> | getFields()
Gets the stepfields in the search request. | | int | getMaxNumber()
Gets the maximum number of results to be returned, or -1 if the number of results to be returned is unlimited. | | int | getOffset()
Gets the (zerobased) offset in the list of results, of the first result to return. | | List<SortOrder> | getSortOrders()
Gets the SortOrder objects in the order they are to be applied. | | List<Step> | getSteps()
Gets the steps in the search request. | | public int | hashCode()
| | boolean | isAggregating()
Tests if this is an aggregating query, i.e. | | boolean | isDistinct()
Tests if the search request is to return distinct results. | | public String | toString()
Returns a string representation of this SearchQuery. |
| equals | | public boolean equals(Object obj)(Code) | | Compares this query to the specified object. The result is
true if and only if the argument is a non-null
SearchQuery object representing the same query.
Parameters:
obj - The object to compare with. true if the objects are equal,false otherwise. |
| getConstraint | | Constraint getConstraint()(Code) | | Gets the constraints on the search results.
This corresponds to (part of) the constraints in the WHERE-clause in SQL SELECT-syntax.
|
| getFields | | List<StepField> getFields()(Code) | | Gets the stepfields in the search request.
This corresponds to the fields in SQL SELECT-syntax.
|
| getMaxNumber | | int getMaxNumber()(Code) | | Gets the maximum number of results to be returned, or -1 if the number of results to be returned is unlimited.
Note: limiting the number of results may not be supported by the database layer.
|
| getOffset | | int getOffset()(Code) | | Gets the (zerobased) offset in the list of results, of the first result to return. Note that,
since it is zerobased, it is equal to the number of results that are skipped. Note:
skipping results may not be supported by the database layer.
|
| getSortOrders | | List<SortOrder> getSortOrders()(Code) | | Gets the SortOrder objects in the order they are to be applied.
This specifies the sorting order of the search results.
This corresponds to the ORDER BY clause in SQL SELECT syntax.
|
| getSteps | | List<Step> getSteps()(Code) | | Gets the steps in the search request.
This corresponds to the tables in SQL SELECT-syntax.
|
| hashCode | | public int hashCode()(Code) | | |
| isAggregating | | boolean isAggregating()(Code) | | Tests if this is an aggregating query, i.e. containing aggregated fields.
|
| isDistinct | | boolean isDistinct()(Code) | | Tests if the search request is to return distinct results. In that case duplicate nodes will be removed from the result.
This corresponds to the use of "DISTINCT" in SQL SELECT-syntax
.
|
| toString | | public String toString()(Code) | | Returns a string representation of this SearchQuery.
The string representation has the form
"SearchQuery(distinct:<distinct>,
steps:<steps>, fields:<fields>,
constraint:<constraint>, sortorders:<sortorders>,
max:<max>, offset:<offset>)"
where
A string representation of this SearchQuery. |
|
|