|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.4.0) E15995-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.webcenter.search.Query
public class Query
A Query captures all that is needed to perform a runtime query against a Search API implementation. A client will create a Query from a simple constructor. He will set the Query's Predicate when he has it available and then call "QueryExecutor.executeQuery(Query)" to return a QueryResult. The annotations using XmlAttribute and XmlElement will allow for a Query to be persisted into XML and also read from an XML source, using JAXB 2.0.
Nested Class Summary | |
---|---|
static class |
Query.SortDirection The direction to perform the sort - either Ascending or Descending |
Constructor Summary | |
---|---|
Query() Empty constructor. |
Method Summary | |
---|---|
void |
addLocation(java.lang.String location) Adds a starting path. |
Query |
cloneQuery() |
java.util.List<java.lang.String> |
getLocations() Return the starting paths for the search. |
Predicate |
getPredicate() The ComplexPredicate handles the joining of Conditions with ANDs and ORs. |
java.lang.String |
getScope() Retrieves a String scope value in which the search execution will take place. |
QName |
getSortBy() Gets the name of the attribute by which the results should be sorted. |
Query.SortDirection |
getSortDirection() Gets the Sorting direction of the Query results. |
void |
setLocations(java.util.List<java.lang.String> locations) Sets the starting paths. |
void |
setPredicate(Predicate queryPredicate) This sets the QueryPredicate value. |
void |
setScope(java.lang.String scope) Sets the scope of the Query. |
void |
setSortBy(QName sortBy) Sets the attribute name to sort results by. |
void |
setSortDirection(Query.SortDirection sortDirection) Sets the direction of the sort. |
java.lang.String |
toString() Renders the String representation of the Query object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Query()
Method Detail |
---|
public java.lang.String getScope()
public void setScope(java.lang.String scope)
scope
- String scope for the querypublic void setLocations(java.util.List<java.lang.String> locations)
locations
- an Iterator that states the starting paths for this querypublic void addLocation(java.lang.String location)
location
- a String path to add to the list of starting pathspublic java.util.List<java.lang.String> getLocations()
public Predicate getPredicate()
public void setPredicate(Predicate queryPredicate)
queryPredicate
- the query Predicate to be set.public Query.SortDirection getSortDirection()
public void setSortDirection(Query.SortDirection sortDirection)
sortDirection
- QName representing the attribute name to sort bypublic QName getSortBy()
public void setSortBy(QName sortBy)
sortBy
- QName representing the attribute name to sort bypublic java.lang.String toString()
toString
in class java.lang.Object
public Query cloneQuery()
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.4.0) E15995-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |