|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.jackrabbit.core.query.lucene.AbstractQueryImpl
public abstract class AbstractQueryImpl
AbstractQueryImpl
provides a base class for executable queries
based on SearchIndex
.
Field Summary | |
---|---|
protected SearchIndex |
index
The actual search index |
protected ItemManager |
itemMgr
The item manager of the user executing this query |
protected PropertyTypeRegistry |
propReg
The property type registry for type lookup. |
protected SessionImpl |
session
The session of the user executing this query |
Constructor Summary | |
---|---|
AbstractQueryImpl(SessionImpl session,
ItemManager itemMgr,
SearchIndex index,
PropertyTypeRegistry propReg)
Creates a new query instance from a query string. |
Method Summary | |
---|---|
protected void |
addVariableName(Name varName)
Adds a name to the set of variables. |
void |
bindValue(Name varName,
Value value)
Binds the given value to the variable named
varName . |
protected Map |
getBindVariableValues()
|
boolean |
getRespectDocumentOrder()
If set true the result nodes will be in document order
per default (if no order by clause is specified). |
abstract boolean |
needsSystemTree()
Returns true if this query node needs items under
/jcr:system to be queried. |
void |
setRespectDocumentOrder(boolean documentOrder)
Sets a new value for this property. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.jackrabbit.core.query.ExecutableQuery |
---|
execute |
Field Detail |
---|
protected final SessionImpl session
protected final ItemManager itemMgr
protected final SearchIndex index
protected final PropertyTypeRegistry propReg
Constructor Detail |
---|
public AbstractQueryImpl(SessionImpl session, ItemManager itemMgr, SearchIndex index, PropertyTypeRegistry propReg)
session
- the session of the user executing this query.itemMgr
- the item manager of the session executing this query.index
- the search index.propReg
- the property type registry.Method Detail |
---|
public boolean getRespectDocumentOrder()
true
the result nodes will be in document order
per default (if no order by clause is specified). If set to
false
the result nodes are returned in whatever sequence
the index has stored the nodes. That sequence is stable over multiple
invocations of the same query, but will change when nodes get added or
removed from the index.
The default value for this property is true
.
public void setRespectDocumentOrder(boolean documentOrder)
documentOrder
- if true
the result nodes are in
document order per default.getRespectDocumentOrder()
public void bindValue(Name varName, Value value) throws IllegalArgumentException, RepositoryException
value
to the variable named
varName
.
bindValue
in interface ExecutableQuery
varName
- name of variable in queryvalue
- value to bind
IllegalArgumentException
- if varName
is not a valid
variable in this query.
RepositoryException
- if an error occurs.protected void addVariableName(Name varName)
varName
- the name of the variable.protected Map getBindVariableValues()
public abstract boolean needsSystemTree()
true
if this query node needs items under
/jcr:system to be queried.
true
if this query node needs content under
/jcr:system to be queried; false
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |