|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.search.Query
org.modeshape.search.lucene.query.CompareQuery<Path.Segment>
org.modeshape.search.lucene.query.CompareNameQuery
public class CompareNameQuery
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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.modeshape.search.lucene.query.CompareQuery |
---|
CompareQuery.CompareScorer, CompareQuery.CompareWeight, CompareQuery.Evaluator<ValueType> |
Field Summary | |
---|---|
protected static CompareQuery.Evaluator<Path.Segment> |
EQUAL_TO
|
protected static CompareQuery.Evaluator<Path.Segment> |
EQUAL_TO_NO_SNS
|
protected static CompareQuery.Evaluator<Path.Segment> |
IS_GREATER_THAN
|
protected static CompareQuery.Evaluator<Path.Segment> |
IS_GREATER_THAN_NO_SNS
|
protected static CompareQuery.Evaluator<Path.Segment> |
IS_GREATER_THAN_OR_EQUAL_TO
|
protected static CompareQuery.Evaluator<Path.Segment> |
IS_GREATER_THAN_OR_EQUAL_TO_NO_SNS
|
protected static CompareQuery.Evaluator<Path.Segment> |
IS_LESS_THAN
|
protected static CompareQuery.Evaluator<Path.Segment> |
IS_LESS_THAN_NO_SNS
|
protected static CompareQuery.Evaluator<Path.Segment> |
IS_LESS_THAN_OR_EQUAL_TO
|
protected static CompareQuery.Evaluator<Path.Segment> |
IS_LESS_THAN_OR_EQUAL_TO_NO_SNS
|
Fields inherited from class org.modeshape.search.lucene.query.CompareQuery |
---|
constraintValue, evaluator, fieldName, fieldSelector, stringFactory, valueTypeFactory |
Constructor Summary | |
---|---|
protected |
CompareNameQuery(String localNameField,
String snsIndexFieldName,
Path.Segment constraintValue,
PathFactory pathFactory,
ValueFactory<String> stringFactory,
ValueFactory<Long> longFactory,
CompareQuery.Evaluator<Path.Segment> evaluator,
CaseOperations.CaseOperation caseOperation)
Construct a Query implementation that scores nodes according to the supplied comparator. |
Method Summary | |
---|---|
Object |
clone()
|
static org.apache.lucene.search.Query |
createQueryForNodesWithNameEqualTo(Path.Segment constraintValue,
String localNameField,
String snsIndexFieldName,
ValueFactories factories,
CaseOperations.CaseOperation caseOperation,
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 |
createQueryForNodesWithNameGreaterThan(Path.Segment constraintValue,
String localNameField,
String snsIndexFieldName,
ValueFactories factories,
CaseOperations.CaseOperation caseOperation,
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,
CaseOperations.CaseOperation caseOperation,
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,
CaseOperations.CaseOperation caseOperation,
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,
CaseOperations.CaseOperation caseOperation,
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.modeshape.search.lucene.query.CompareQuery |
---|
createWeight, toString |
Methods inherited from class org.apache.lucene.search.Query |
---|
combine, equals, extractTerms, getBoost, getSimilarity, hashCode, mergeBooleanQueries, rewrite, setBoost, toString, weight |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected static final CompareQuery.Evaluator<Path.Segment> EQUAL_TO
protected static final CompareQuery.Evaluator<Path.Segment> IS_LESS_THAN
protected static final CompareQuery.Evaluator<Path.Segment> IS_LESS_THAN_OR_EQUAL_TO
protected static final CompareQuery.Evaluator<Path.Segment> IS_GREATER_THAN
protected static final CompareQuery.Evaluator<Path.Segment> IS_GREATER_THAN_OR_EQUAL_TO
protected static final CompareQuery.Evaluator<Path.Segment> EQUAL_TO_NO_SNS
protected static final CompareQuery.Evaluator<Path.Segment> IS_LESS_THAN_NO_SNS
protected static final CompareQuery.Evaluator<Path.Segment> IS_LESS_THAN_OR_EQUAL_TO_NO_SNS
protected static final CompareQuery.Evaluator<Path.Segment> IS_GREATER_THAN_NO_SNS
protected static final CompareQuery.Evaluator<Path.Segment> IS_GREATER_THAN_OR_EQUAL_TO_NO_SNS
Constructor Detail |
---|
protected CompareNameQuery(String localNameField, String snsIndexFieldName, Path.Segment constraintValue, PathFactory pathFactory, ValueFactory<String> stringFactory, ValueFactory<Long> longFactory, CompareQuery.Evaluator<Path.Segment> evaluator, CaseOperations.CaseOperation caseOperation)
Query
implementation that scores nodes according to the supplied comparator.
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 nullcaseOperation
- the operation to be performed on the indexed values before matching; may not be nullMethod Detail |
---|
public static org.apache.lucene.search.Query createQueryForNodesWithNameEqualTo(Path.Segment constraintValue, String localNameField, String snsIndexFieldName, ValueFactories factories, CaseOperations.CaseOperation caseOperation, boolean includeSns)
Query
implementation that scores documents such that the node represented by the document has a name
that is greater than the supplied constraint name.
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 nullcaseOperation
- the operation that should be performed on the indexed values before the constraint value is being
evaluated; may not be nullincludeSns
- true if the SNS index should be considered, or false if the SNS value should be ignored
public static CompareNameQuery createQueryForNodesWithNameGreaterThan(Path.Segment constraintValue, String localNameField, String snsIndexFieldName, ValueFactories factories, CaseOperations.CaseOperation caseOperation, boolean includeSns)
Query
implementation that scores documents such that the node represented by the document has a name
that is greater than the supplied constraint name.
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 nullcaseOperation
- the operation to be performed on the indexed values before matching; may not be nullincludeSns
- true if the SNS index should be considered, or false if the SNS value should be ignored
public static CompareNameQuery createQueryForNodesWithNameGreaterThanOrEqualTo(Path.Segment constraintValue, String localNameField, String snsIndexFieldName, ValueFactories factories, CaseOperations.CaseOperation caseOperation, boolean includeSns)
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.
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 nullcaseOperation
- the operation to be performed on the indexed values before matching; may not be nullincludeSns
- true if the SNS index should be considered, or false if the SNS value should be ignored
public static CompareNameQuery createQueryForNodesWithNameLessThan(Path.Segment constraintValue, String localNameField, String snsIndexFieldName, ValueFactories factories, CaseOperations.CaseOperation caseOperation, boolean includeSns)
Query
implementation that scores documents such that the node represented by the document has a name
that is less than the supplied constraint name.
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 nullcaseOperation
- the operation to be performed on the indexed values before matching; may not be nullincludeSns
- true if the SNS index should be considered, or false if the SNS value should be ignored
public static CompareNameQuery createQueryForNodesWithNameLessThanOrEqualTo(Path.Segment constraintValue, String localNameField, String snsIndexFieldName, ValueFactories factories, CaseOperations.CaseOperation caseOperation, boolean includeSns)
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.
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 nullcaseOperation
- the operation to be performed on the indexed values before matching; may not be nullincludeSns
- true if the SNS index should be considered, or false if the SNS value should be ignored
protected Path.Segment readFromDocument(org.apache.lucene.index.IndexReader reader, int docId) throws IOException
readFromDocument
in class CompareQuery<Path.Segment>
IOException
CompareQuery.readFromDocument(org.apache.lucene.index.IndexReader, int)
public Object clone()
clone
in class org.apache.lucene.search.Query
Query.clone()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |