public final class Request extends Object
A request is executed by calling the method execute()
.
Note that this class is not synchronized.
See Setting a fetch size
on optimization with respect to the expected size of the RequestResult
and the limitations when using PostgreSQL as the underlying database.
AdaptationTable.createRequest()
Modifier and Type | Method and Description |
---|---|
RequestResult |
execute()
Executes the request and returns the result.
|
int |
getFetchSize() |
Locale |
getLocale() |
RequestSortCriteria |
getSortCriteria() |
AdaptationFilter |
getSpecificFilter()
Returns the current filter, if any.
|
boolean |
isIncludeOcculting() |
RequestPagination |
paginate()
Returns a new object to be used to paginate over the
result of this request.
|
void |
setFetchSize(int rows)
Provides a hint to the underlying database as to the number of records
to fetch at a time from the result of
executing
this request. |
void |
setIncludeOcculting(boolean includeOcculting)
If the argument is
true , this method specifies that
the request result will include records in occulting mode. |
void |
setLocale(Locale aLocale)
Sets a locale to the request.
|
void |
setOrderByPrimaryKey()
Specifies that the request result will be sorted by primary key
in ascending order.
|
void |
setSession(Session aSession)
Sets the user session on the request.
|
void |
setSortCriteria(RequestSortCriteria aSortCriteria)
Specifies that the request result will be sorted according to the
specified criteria.
|
void |
setSpecificFilter(AdaptationFilter aFilter)
Specifies that the request result will only include the records that
satisfy the filter passed as an argument.
|
void |
setXPathFilter(String aPredicateExpression)
Specifies that the request result will only include the records which
satisfy the specified XPath predicate.
|
void |
setXPathFilter(XPathFilter anXPathFilter)
Specifies that the request result will only include the records which
satisfy the specified XPath filter.
|
void |
setXPathParameter(String aParameterName,
Object aParameterValue)
For the current XPath filter, sets the value of the specified parameter.
|
String |
toString() |
public boolean isIncludeOcculting()
setIncludeOcculting(boolean)
public void setIncludeOcculting(boolean includeOcculting)
true
, this method specifies that
the request result will include records in occulting mode.
If the argument is false
, records in occulting mode
are not included in the result. If the property is not set, it is considered
to be false
.
public Locale getLocale()
setLocale(Locale)
public void setLocale(Locale aLocale)
osd:label(./localized_field)='A'
.setSession(Session)
public void setSession(Session aSession)
setLocale(Locale)
public RequestSortCriteria getSortCriteria()
setSortCriteria(RequestSortCriteria)
public void setOrderByPrimaryKey()
setSortCriteria(RequestSortCriteria)
public void setSortCriteria(RequestSortCriteria aSortCriteria)
If this method is not called, the default sort order is undefined, in which case the results will be sorted according to the order of whichever index is selected for computing the request. If no filter is specified, the result will be ordered according to the primary key fields (ascending).
IllegalArgumentException
- if the specified sort is not consistent with the table structure.setOrderByPrimaryKey()
,
AdaptationTable.createRequestResult(String, RequestSortCriteria)
public AdaptationFilter getSpecificFilter()
public void setSpecificFilter(AdaptationFilter aFilter)
If not set, the value of this property is null
, and no
specific filtering will be performed.
If a filter has been specified by means of a method setXPathFilter
,
it is replaced by the specified filter.
setXPathFilter(XPathFilter)
public void setXPathFilter(String aPredicateExpression)
This method is equivalent to:
XPathFilter xpf = XPathFilter.newFilter(false, aPredicateExpression); this.setXPathFilter(xpf);
Performance considerations: If the specified predicate must
be often reused by multiple Request
objects,
it is recommended to use a cached filter.
Parameterized expressions also help reuse.
setXPathFilter(XPathFilter)
public void setXPathFilter(XPathFilter anXPathFilter)
If a filter has been specified by means of
the method
,
it is replaced by the specified XPath filter.
setSpecificFilter(AdaptationFilter)
It is recommended to use the XPath filter when the predicate must be applied more than once, with different values. It allows using parameters and avoiding parsing the same predicate expression each time it is used.
setXPathParameter(String, Object)
,
XPath supported syntaxpublic void setXPathParameter(String aParameterName, Object aParameterValue)
For example, if the current filter is the XPath predicate
./lastName=$myName
, to set the parameter myName
to 'Smith', the method must be invoked this way:
aRequest.setXPathParameter("myName", "Smith");
aParameterName
- name of the parameteraParameterValue
- value of the parameterIllegalArgumentException
- if one of the specified arguments is not defined
or if the specified parameter name has basic inconsistencies.IllegalStateException
- if no XPath filter has been specified.setXPathFilter(String)
public int getFetchSize()
setFetchSize(int)
public void setFetchSize(int rows)
executing
this request. If the fetch size specified is '0', the underlying implementation
determines the fetch size independently.
See Setting a fetch size for the limitations when using PostgreSQL as the underlying database.
rows
- the number of rows to fetchStatement.setFetchSize(int)
public RequestResult execute() throws IncompatibleChangeError
IncompatibleChangeError
public RequestPagination paginate()