org.modeshape.search.lucene.query
Class ComparePathQuery
java.lang.Object
org.apache.lucene.search.Query
org.modeshape.search.lucene.query.CompareQuery<Path>
org.modeshape.search.lucene.query.ComparePathQuery
- All Implemented Interfaces:
- Serializable, Cloneable
public class ComparePathQuery
- extends CompareQuery<Path>
A Lucene Query
implementation that is used to apply a Comparison
constraint against the Path of nodes. This
query implementation works by using the weight
and
scorer
of the wrapped query to score (and return) only those documents
that correspond to nodes with Paths that satisfy the constraint.
- See Also:
- Serialized Form
Method Summary |
Object |
clone()
|
static ComparePathQuery |
createQueryForNodesWithPathGreaterThan(Path constraintPath,
String fieldName,
ValueFactories factories,
boolean caseSensitive)
Construct a Query implementation that scores documents such that the node represented by the document has a path
that is greater than the supplied constraint path. |
static ComparePathQuery |
createQueryForNodesWithPathGreaterThanOrEqualTo(Path constraintPath,
String fieldName,
ValueFactories factories,
boolean caseSensitive)
Construct a Query implementation that scores documents such that the node represented by the document has a path
that is greater than or equal to the supplied constraint path. |
static ComparePathQuery |
createQueryForNodesWithPathLessThan(Path constraintPath,
String fieldName,
ValueFactories factories,
boolean caseSensitive)
Construct a Query implementation that scores documents such that the node represented by the document has a path
that is less than the supplied constraint path. |
static ComparePathQuery |
createQueryForNodesWithPathLessThanOrEqualTo(Path constraintPath,
String fieldName,
ValueFactories factories,
boolean caseSensitive)
Construct a Query implementation that scores documents such that the node represented by the document has a path
that is less than or equal to the supplied constraint path. |
protected Path |
readFromDocument(org.apache.lucene.index.IndexReader reader,
int docId)
|
Methods inherited from class org.apache.lucene.search.Query |
combine, equals, extractTerms, getBoost, getSimilarity, hashCode, mergeBooleanQueries, rewrite, setBoost, toString, weight |
PATH_IS_LESS_THAN
protected static final CompareQuery.Evaluator<Path> PATH_IS_LESS_THAN
PATH_IS_LESS_THAN_OR_EQUAL_TO
protected static final CompareQuery.Evaluator<Path> PATH_IS_LESS_THAN_OR_EQUAL_TO
PATH_IS_GREATER_THAN
protected static final CompareQuery.Evaluator<Path> PATH_IS_GREATER_THAN
PATH_IS_GREATER_THAN_OR_EQUAL_TO
protected static final CompareQuery.Evaluator<Path> PATH_IS_GREATER_THAN_OR_EQUAL_TO
ComparePathQuery
protected ComparePathQuery(String fieldName,
Path constraintPath,
ValueFactory<Path> pathFactory,
ValueFactory<String> stringFactory,
CompareQuery.Evaluator<Path> evaluator,
boolean caseSensitive)
- Construct a
Query
implementation that scores nodes according to the supplied comparator.
- Parameters:
fieldName
- the name of the document field containing the path value; may not be nullconstraintPath
- the constraint path; may not be nullpathFactory
- the value factory that can be used during the scoring; may not be nullstringFactory
- the string factory that can be used during the scoring; may not be nullevaluator
- the CompareQuery.Evaluator
implementation that returns whether the node path satisfies the
constraint; may not be nullcaseSensitive
- true if the comparison should be done in a case-sensitive manner, or false if it is to be
case-insensitive
createQueryForNodesWithPathGreaterThan
public static ComparePathQuery createQueryForNodesWithPathGreaterThan(Path constraintPath,
String fieldName,
ValueFactories factories,
boolean caseSensitive)
- Construct a
Query
implementation that scores documents such that the node represented by the document has a path
that is greater than the supplied constraint path.
- Parameters:
constraintPath
- the constraint path; may not be nullfieldName
- the name of the document field containing the path value; may not be nullfactories
- the value factories that can be used during the scoring; may not be nullcaseSensitive
- true if the comparison should be done in a case-sensitive manner, or false if it is to be
case-insensitive
- Returns:
- the path query; never null
createQueryForNodesWithPathGreaterThanOrEqualTo
public static ComparePathQuery createQueryForNodesWithPathGreaterThanOrEqualTo(Path constraintPath,
String fieldName,
ValueFactories factories,
boolean caseSensitive)
- Construct a
Query
implementation that scores documents such that the node represented by the document has a path
that is greater than or equal to the supplied constraint path.
- Parameters:
constraintPath
- the constraint path; may not be nullfieldName
- the name of the document field containing the path value; may not be nullfactories
- the value factories that can be used during the scoring; may not be nullcaseSensitive
- true if the comparison should be done in a case-sensitive manner, or false if it is to be
case-insensitive
- Returns:
- the path query; never null
createQueryForNodesWithPathLessThan
public static ComparePathQuery createQueryForNodesWithPathLessThan(Path constraintPath,
String fieldName,
ValueFactories factories,
boolean caseSensitive)
- Construct a
Query
implementation that scores documents such that the node represented by the document has a path
that is less than the supplied constraint path.
- Parameters:
constraintPath
- the constraint path; may not be nullfieldName
- the name of the document field containing the path value; may not be nullfactories
- the value factories that can be used during the scoring; may not be nullcaseSensitive
- true if the comparison should be done in a case-sensitive manner, or false if it is to be
case-insensitive
- Returns:
- the path query; never null
createQueryForNodesWithPathLessThanOrEqualTo
public static ComparePathQuery createQueryForNodesWithPathLessThanOrEqualTo(Path constraintPath,
String fieldName,
ValueFactories factories,
boolean caseSensitive)
- Construct a
Query
implementation that scores documents such that the node represented by the document has a path
that is less than or equal to the supplied constraint path.
- Parameters:
constraintPath
- the constraint path; may not be nullfieldName
- the name of the document field containing the path value; may not be nullfactories
- the value factories that can be used during the scoring; may not be nullcaseSensitive
- true if the comparison should be done in a case-sensitive manner, or false if it is to be
case-insensitive
- Returns:
- the path query; never null
readFromDocument
protected Path readFromDocument(org.apache.lucene.index.IndexReader reader,
int docId)
throws IOException
-
- Overrides:
readFromDocument
in class CompareQuery<Path>
- Throws:
IOException
- See Also:
CompareQuery.readFromDocument(org.apache.lucene.index.IndexReader, int)
clone
public Object clone()
-
- Overrides:
clone
in class org.apache.lucene.search.Query
- See Also:
Query.clone()
Copyright © 2008-2010 JBoss, a division of Red Hat. All Rights Reserved.