org.neo4j.kernel.api.impl.schema

Class LuceneDocumentStructure

java.lang.Object

org.neo4j.kernel.api.impl.schema.LuceneDocumentStructure

public class LuceneDocumentStructure
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODE_ID_KEY

Method Summary

Modifier and Type	Method and Description
static org.apache.lucene.document.Document	documentRepresentingProperty(long nodeId, Object value)
static String	encodedStringValue(Object value)
static long	getNodeId(org.apache.lucene.document.Document from)
static org.apache.lucene.search.NumericRangeQuery<Double>	newInclusiveNumericRangeSeekQuery(Number lower, Number upper) Range queries are always inclusive, in order to do exclusive range queries the result must be filtered after the fact.
static org.apache.lucene.search.Query	newRangeSeekByPrefixQuery(String prefix)
static org.apache.lucene.search.Query	newRangeSeekByStringQuery(String lower, boolean includeLower, String upper, boolean includeUpper)
static org.apache.lucene.search.MatchAllDocsQuery	newScanQuery()
static org.apache.lucene.search.Query	newSeekQuery(Object value)
static org.apache.lucene.search.Query	newSuffixStringQuery(String suffix)
static org.apache.lucene.index.Term	newTermForChangeOrRemove(long nodeId)
static org.apache.lucene.search.Query	newWildCardStringQuery(String searchFor)
static org.apache.lucene.index.TermsEnum	originalTerms(org.apache.lucene.index.Terms terms, String fieldKey) Filters the given terms to include only terms that were created using fields from ValueEncoding.encodeField(Object).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NODE_ID_KEY

public static final String NODE_ID_KEY

See Also:

Constant Field Values

Method Detail

documentRepresentingProperty

public static org.apache.lucene.document.Document documentRepresentingProperty(long nodeId,
                                                                               Object value)

encodedStringValue

public static String encodedStringValue(Object value)

newScanQuery

public static org.apache.lucene.search.MatchAllDocsQuery newScanQuery()

newSeekQuery

public static org.apache.lucene.search.Query newSeekQuery(Object value)

newInclusiveNumericRangeSeekQuery

public static org.apache.lucene.search.NumericRangeQuery<Double> newInclusiveNumericRangeSeekQuery(Number lower,
                                                                                                   Number upper)

Range queries are always inclusive, in order to do exclusive range queries the result must be filtered after the fact. The reason we can't do inclusive range queries is that longs are coerced to doubles in the index.

newRangeSeekByStringQuery

public static org.apache.lucene.search.Query newRangeSeekByStringQuery(String lower,
                                                                       boolean includeLower,
                                                                       String upper,
                                                                       boolean includeUpper)

newWildCardStringQuery

public static org.apache.lucene.search.Query newWildCardStringQuery(String searchFor)

newRangeSeekByPrefixQuery

public static org.apache.lucene.search.Query newRangeSeekByPrefixQuery(String prefix)

newSuffixStringQuery

public static org.apache.lucene.search.Query newSuffixStringQuery(String suffix)

newTermForChangeOrRemove

public static org.apache.lucene.index.Term newTermForChangeOrRemove(long nodeId)

getNodeId

public static long getNodeId(org.apache.lucene.document.Document from)

originalTerms

public static org.apache.lucene.index.TermsEnum originalTerms(org.apache.lucene.index.Terms terms,
                                                              String fieldKey)
                                                       throws IOException

Filters the given terms to include only terms that were created using fields from ValueEncoding.encodeField(Object). Internal lucene terms like those created for indexing numeric values (see javadoc for NumericRangeQuery class) are skipped. In other words this method returns TermsEnum over all terms for the given field that were created using ValueEncoding.

Parameters:

terms - the terms to be filtered

fieldKey - the corresponding field key

Returns:

terms enum over all inserted terms

Throws:

IOException - if it is not possible to obtain TermsEnum

See Also:

NumericRangeQuery, NumericTokenStream, NumericUtils.PRECISION_STEP_DEFAULT, NumericUtils.filterPrefixCodedLongs(TermsEnum)