org.modeshape.search.lucene.query
Class CompareNameQuery
java.lang.Object
org.apache.lucene.search.Query
org.modeshape.search.lucene.query.CompareQuery<Path.Segment>
org.modeshape.search.lucene.query.CompareNameQuery
- All Implemented Interfaces:
- Serializable, Cloneable
public class CompareNameQuery
- extends CompareQuery<Path.Segment>
A Lucene Query
implementation that is used to apply a Comparison
constraint against the name 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 Names that satisfy the constraint.
- See Also:
- Serialized Form
Method Summary |
Object |
clone()
|
static CompareNameQuery |
createQueryForNodesWithNameGreaterThan(Path.Segment constraintValue,
String localNameField,
String snsIndexFieldName,
ValueFactories factories,
boolean caseSensitive,
boolean includeSns)
Construct a Query implementation that scores documents such that the node represented by the document has a name
that is greater than the supplied constraint name. |
static CompareNameQuery |
createQueryForNodesWithNameGreaterThanOrEqualTo(Path.Segment constraintValue,
String localNameField,
String snsIndexFieldName,
ValueFactories factories,
boolean caseSensitive,
boolean includeSns)
Construct a Query implementation that scores documents such that the node represented by the document has a name
that is greater than or equal to the supplied constraint name. |
static CompareNameQuery |
createQueryForNodesWithNameLessThan(Path.Segment constraintValue,
String localNameField,
String snsIndexFieldName,
ValueFactories factories,
boolean caseSensitive,
boolean includeSns)
Construct a Query implementation that scores documents such that the node represented by the document has a name
that is less than the supplied constraint name. |
static CompareNameQuery |
createQueryForNodesWithNameLessThanOrEqualTo(Path.Segment constraintValue,
String localNameField,
String snsIndexFieldName,
ValueFactories factories,
boolean caseSensitive,
boolean includeSns)
Construct a Query implementation that scores documents such that the node represented by the document has a name
that is less than or equal to the supplied constraint name. |
protected Path.Segment |
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 |
IS_LESS_THAN
protected static final CompareQuery.Evaluator<Path.Segment> IS_LESS_THAN
IS_LESS_THAN_OR_EQUAL_TO
protected static final CompareQuery.Evaluator<Path.Segment> IS_LESS_THAN_OR_EQUAL_TO
IS_GREATER_THAN
protected static final CompareQuery.Evaluator<Path.Segment> IS_GREATER_THAN
IS_GREATER_THAN_OR_EQUAL_TO
protected static final CompareQuery.Evaluator<Path.Segment> IS_GREATER_THAN_OR_EQUAL_TO
IS_LESS_THAN_NO_SNS
protected static final CompareQuery.Evaluator<Path.Segment> IS_LESS_THAN_NO_SNS
IS_LESS_THAN_OR_EQUAL_TO_NO_SNS
protected static final CompareQuery.Evaluator<Path.Segment> IS_LESS_THAN_OR_EQUAL_TO_NO_SNS
IS_GREATER_THAN_NO_SNS
protected static final CompareQuery.Evaluator<Path.Segment> IS_GREATER_THAN_NO_SNS
IS_GREATER_THAN_OR_EQUAL_TO_NO_SNS
protected static final CompareQuery.Evaluator<Path.Segment> IS_GREATER_THAN_OR_EQUAL_TO_NO_SNS
CompareNameQuery
protected CompareNameQuery(String localNameField,
String snsIndexFieldName,
Path.Segment constraintValue,
PathFactory pathFactory,
ValueFactory<String> stringFactory,
ValueFactory<Long> longFactory,
CompareQuery.Evaluator<Path.Segment> evaluator,
boolean caseSensitive)
- Construct a
Query
implementation that scores nodes according to the supplied comparator.
- Parameters:
localNameField
- the name of the document field containing the local name value; may not be nullsnsIndexFieldName
- the name of the document field containing the same-name-sibling index; may not be nullconstraintValue
- the constraint path; may not be nullpathFactory
- the path 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 nulllongFactory
- the long 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
createQueryForNodesWithNameGreaterThan
public static CompareNameQuery createQueryForNodesWithNameGreaterThan(Path.Segment constraintValue,
String localNameField,
String snsIndexFieldName,
ValueFactories factories,
boolean caseSensitive,
boolean includeSns)
- Construct a
Query
implementation that scores documents such that the node represented by the document has a name
that is greater than the supplied constraint name.
- Parameters:
constraintValue
- the constraint value; may not be nulllocalNameField
- the name of the document field containing the local name value; may not be nullsnsIndexFieldName
- the name of the document field containing the same-name-sibling index; 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-insensitiveincludeSns
- true if the SNS index should be considered, or false if the SNS value should be ignored
- Returns:
- the query; never null
createQueryForNodesWithNameGreaterThanOrEqualTo
public static CompareNameQuery createQueryForNodesWithNameGreaterThanOrEqualTo(Path.Segment constraintValue,
String localNameField,
String snsIndexFieldName,
ValueFactories factories,
boolean caseSensitive,
boolean includeSns)
- Construct a
Query
implementation that scores documents such that the node represented by the document has a name
that is greater than or equal to the supplied constraint name.
- Parameters:
constraintValue
- the constraint value; may not be nulllocalNameField
- the name of the document field containing the local name value; may not be nullsnsIndexFieldName
- the name of the document field containing the same-name-sibling index; 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-insensitiveincludeSns
- true if the SNS index should be considered, or false if the SNS value should be ignored
- Returns:
- the query; never null
createQueryForNodesWithNameLessThan
public static CompareNameQuery createQueryForNodesWithNameLessThan(Path.Segment constraintValue,
String localNameField,
String snsIndexFieldName,
ValueFactories factories,
boolean caseSensitive,
boolean includeSns)
- Construct a
Query
implementation that scores documents such that the node represented by the document has a name
that is less than the supplied constraint name.
- Parameters:
constraintValue
- the constraint value; may not be nulllocalNameField
- the name of the document field containing the local name value; may not be nullsnsIndexFieldName
- the name of the document field containing the same-name-sibling index; 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-insensitiveincludeSns
- true if the SNS index should be considered, or false if the SNS value should be ignored
- Returns:
- the query; never null
createQueryForNodesWithNameLessThanOrEqualTo
public static CompareNameQuery createQueryForNodesWithNameLessThanOrEqualTo(Path.Segment constraintValue,
String localNameField,
String snsIndexFieldName,
ValueFactories factories,
boolean caseSensitive,
boolean includeSns)
- Construct a
Query
implementation that scores documents such that the node represented by the document has a name
that is less than or equal to the supplied constraint name.
- Parameters:
constraintValue
- the constraint value; may not be nulllocalNameField
- the name of the document field containing the local name value; may not be nullsnsIndexFieldName
- the name of the document field containing the same-name-sibling index; 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-insensitiveincludeSns
- true if the SNS index should be considered, or false if the SNS value should be ignored
- Returns:
- the query; never null
readFromDocument
protected Path.Segment readFromDocument(org.apache.lucene.index.IndexReader reader,
int docId)
throws IOException
-
- Overrides:
readFromDocument
in class CompareQuery<Path.Segment>
- 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-2012 JBoss, a division of Red Hat. All Rights Reserved.