Index (geode-lucene 1.13.2 API)

A C D F G H I L N O P R S T W

A

addField(String) - Method in interface org.apache.geode.cache.lucene.LuceneIndexFactory: Add a field to be indexed
addField(String, Analyzer) - Method in interface org.apache.geode.cache.lucene.LuceneIndexFactory: Add a field to be indexed, using the specified analyzer.
analyzer - Variable in class org.apache.geode.cache.lucene.management.configuration.Index.Field

C

create(String, String) - Method in interface org.apache.geode.cache.lucene.LuceneIndexFactory: Create the index on this member.
create(String, String, String, String) - Method in interface org.apache.geode.cache.lucene.LuceneQueryFactory: Creates a query based on a query string which is parsed by Lucene's StandardQueryParser.
create(String, String, LuceneQueryProvider) - Method in interface org.apache.geode.cache.lucene.LuceneQueryFactory: Create a query based on a programmatically constructed Lucene Query.
createIndexFactory() - Method in interface org.apache.geode.cache.lucene.LuceneService: Get a factory for creating a Lucene index on this member.
createLuceneQueryFactory() - Method in interface org.apache.geode.cache.lucene.LuceneService: Create a factory for building a Lucene query.

D

DEFAULT_LIMIT - Static variable in interface org.apache.geode.cache.lucene.LuceneQueryFactory: Default query result limit is 100
DEFAULT_PAGESIZE - Static variable in interface org.apache.geode.cache.lucene.LuceneQueryFactory: Default page size of result is 0, which means no pagination
destroyIndex(String, String) - Method in interface org.apache.geode.cache.lucene.LuceneService: Destroy the Lucene index
destroyIndexes(String) - Method in interface org.apache.geode.cache.lucene.LuceneService: Destroy all the Lucene indexes for the region

F

field - Variable in class org.apache.geode.cache.lucene.management.configuration.Index
Field() - Constructor for class org.apache.geode.cache.lucene.management.configuration.Index.Field
findKeys() - Method in interface org.apache.geode.cache.lucene.LuceneQuery: Execute the query and return the region keys that match this query, up to the limit specified by LuceneQuery.getLimit().
findPages() - Method in interface org.apache.geode.cache.lucene.LuceneQuery: Execute the query and get a PageableLuceneQueryResults.
findResults() - Method in interface org.apache.geode.cache.lucene.LuceneQuery: Execute the query and return a list of LuceneResultStructs that match this query, up to the limit specified by LuceneQuery.getLimit() A LuceneResultStruct contains the region key, value, and a score for that entry.
findValues() - Method in interface org.apache.geode.cache.lucene.LuceneQuery: Execute the query and return the region values that match this query, up to the limit specified by LuceneQuery.getLimit()
FlatFormatSerializer - Class in org.apache.geode.cache.lucene: A built-in LuceneSerializer to parse user's nested object into a flat format, i.e.
FlatFormatSerializer() - Constructor for class org.apache.geode.cache.lucene.FlatFormatSerializer

G

get(GemFireCache) - Static method in class org.apache.geode.cache.lucene.LuceneServiceProvider: Retrieve or create the Lucene service for this cache
getAllIndexes() - Method in interface org.apache.geode.cache.lucene.LuceneService: get all the Lucene indexes.
getAnalyzer() - Method in class org.apache.geode.cache.lucene.management.configuration.Index.Field: Gets the value of the analyzer property.
getCache() - Method in interface org.apache.geode.cache.lucene.LuceneService: returns the cache to which the LuceneService belongs
getCommitRateAverageLatency() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the average latency for the commit operations using the LuceneIndex
getCommits() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the number of commit operations executed on the LuceneIndex
getCommitsInProgress() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the number of commit operations in progress for the LuceneIndex
getCommitTime() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the time consumed by the commit operations on the LuceneIndex
getDocuments() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the number of documents indexed by LuceneIndex
getField() - Method in class org.apache.geode.cache.lucene.management.configuration.Index: Gets the value of the field property.
getFieldAnalyzers() - Method in interface org.apache.geode.cache.lucene.LuceneIndex: Returns a map containing the field name and the Analyzer used to tokenize the field.
getFieldNames() - Method in interface org.apache.geode.cache.lucene.LuceneIndex: Returns a string array containing the fields on which the LuceneIndex was created.
getId() - Method in class org.apache.geode.cache.lucene.management.configuration.Index
getIndex(String, String) - Method in interface org.apache.geode.cache.lucene.LuceneService: Get the Lucene index object specified by region name and index name
getIndexName() - Method in exception org.apache.geode.cache.lucene.LuceneIndexDestroyedException
getIndexName() - Method in exception org.apache.geode.cache.lucene.LuceneIndexExistsException
getIndexName() - Method in exception org.apache.geode.cache.lucene.LuceneIndexNotFoundException
getIndexName() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the String name of the LuceneIndex created
getKey() - Method in interface org.apache.geode.cache.lucene.LuceneResultStruct: Returns the Apache Geode region key of the result matching the Lucene Query
getLimit() - Method in interface org.apache.geode.cache.lucene.LuceneQuery: Get limit size setting of current query.
getLuceneSerializer() - Method in interface org.apache.geode.cache.lucene.LuceneIndex: Return the LuceneSerializer associated with this index
getMaxScore() - Method in interface org.apache.geode.cache.lucene.PageableLuceneQueryResults: Returns the maximum score value across all pages.
getMessage() - Method in exception org.apache.geode.cache.lucene.LuceneIndexExistsException
getName() - Method in interface org.apache.geode.cache.lucene.LuceneIndex: Returns the name of the LuceneIndex object.
getName() - Method in class org.apache.geode.cache.lucene.management.configuration.Index.Field: Gets the value of the name property.
getName() - Method in class org.apache.geode.cache.lucene.management.configuration.Index: Gets the value of the name property.
getPageSize() - Method in interface org.apache.geode.cache.lucene.LuceneQuery: Gets the page size setting of current query.
getQuery(LuceneIndex) - Method in interface org.apache.geode.cache.lucene.LuceneQueryProvider
getQueryExecutions() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the number of query executions using the LuceneIndex
getQueryExecutionsInProgress() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the number of query executions in progress which are using the LuceneIndex
getQueryExecutionTime() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the time duration for execution of queries using the LuceneIndex
getQueryExecutionTotalHits() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the number of hits for the query execution using the LuceneIndex
getQueryRateAverageLatency() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the average latency for query executions using the LuceneIndex
getRegionPath() - Method in interface org.apache.geode.cache.lucene.LuceneIndex: Returns the path of the region on which the LuceneIndex was created.
getRegionPath() - Method in exception org.apache.geode.cache.lucene.LuceneIndexDestroyedException
getRegionPath() - Method in exception org.apache.geode.cache.lucene.LuceneIndexExistsException
getRegionPath() - Method in exception org.apache.geode.cache.lucene.LuceneIndexNotFoundException
getRegionPath() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the String path for the region on which the LuceneIndex is created
getScore() - Method in interface org.apache.geode.cache.lucene.LuceneResultStruct: Return score the score of the entry matching the query.
getSerializer() - Method in class org.apache.geode.cache.lucene.management.configuration.Index: Gets the value of the serializer property.
getUpdateRateAverageLatency() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the average latency for the update operations on the LuceneIndex
getUpdates() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the number of update operations on the LuceneIndex
getUpdatesInProgress() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the number of update operations in progress for the LuceneIndex
getUpdateTime() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Returns the time consumed for the update operations on the LuceneIndex
getValue() - Method in interface org.apache.geode.cache.lucene.LuceneResultStruct: Returns the Apache Geode region key of the result matching the Lucene Query

H

hasNext() - Method in interface org.apache.geode.cache.lucene.PageableLuceneQueryResults: True if there is another page of results in PageableLuceneQueryResults.

I

Index - Class in org.apache.geode.cache.lucene.management.configuration: Java class for anonymous complex type.
Index() - Constructor for class org.apache.geode.cache.lucene.management.configuration.Index
Index.Field - Class in org.apache.geode.cache.lucene.management.configuration: Java class for anonymous complex type.
isIndexingInProgress() - Method in interface org.apache.geode.cache.lucene.LuceneIndex: Returns a boolean value to indicate if reindexing is in progress.
isIndexingInProgress(String, String) - Method in interface org.apache.geode.cache.lucene.LuceneService: Returns if the indexing process is in progress Before executing a lucene query, it can be checked if the indexing operation is in progress.

L

listIndexMetrics() - Method in interface org.apache.geode.cache.lucene.management.LuceneServiceMXBean: Returns an array of LuceneIndexMetrics for the LuceneIndex instances defined in this member
listIndexMetrics(String) - Method in interface org.apache.geode.cache.lucene.management.LuceneServiceMXBean: Returns an array of LuceneIndexMetrics for the LuceneIndex instances defined on the input region in this member
listIndexMetrics(String, String) - Method in interface org.apache.geode.cache.lucene.management.LuceneServiceMXBean: Returns a LuceneIndexMetrics for the LuceneIndex with the input index name defined on the input region in this member.
LuceneIndex - Interface in org.apache.geode.cache.lucene: LuceneIndex represents the Lucene index created over the data stored in Apache Geode regions.
LuceneIndexDestroyedException - Exception in org.apache.geode.cache.lucene: A LuceneIndexDestroyedException is thrown if a Lucene index is attempted to be used while it is being destroyed or after it has been destroyed.
LuceneIndexDestroyedException(String, String) - Constructor for exception org.apache.geode.cache.lucene.LuceneIndexDestroyedException
LuceneIndexExistsException - Exception in org.apache.geode.cache.lucene: A LuceneIndexExistsException is thrown if a Lucene index that already exists is attempted to be created.
LuceneIndexExistsException(String, String) - Constructor for exception org.apache.geode.cache.lucene.LuceneIndexExistsException
LuceneIndexFactory - Interface in org.apache.geode.cache.lucene: A factory for creating a lucene index on the current member.
LuceneIndexMetrics - Class in org.apache.geode.cache.lucene.management
LuceneIndexMetrics(String, String, int, long, long, int, long, int, long, long, int, int, long, long, int, int) - Constructor for class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: This constructor is to be used by internal JMX framework only.
LuceneIndexNotFoundException - Exception in org.apache.geode.cache.lucene: A LuceneIndexNotFoundException is thrown if a Lucene index is requested but not found.
LuceneIndexNotFoundException(String, String) - Constructor for exception org.apache.geode.cache.lucene.LuceneIndexNotFoundException
LuceneQuery<K,V> - Interface in org.apache.geode.cache.lucene: A query on a Lucene index.
LuceneQueryException - Exception in org.apache.geode.cache.lucene: Thrown when a Lucene query fails.
LuceneQueryException(String) - Constructor for exception org.apache.geode.cache.lucene.LuceneQueryException
LuceneQueryException(String, Throwable) - Constructor for exception org.apache.geode.cache.lucene.LuceneQueryException
LuceneQueryException(Throwable) - Constructor for exception org.apache.geode.cache.lucene.LuceneQueryException
LuceneQueryFactory - Interface in org.apache.geode.cache.lucene: Factory for configuring a Lucene query.
LuceneQueryProvider - Interface in org.apache.geode.cache.lucene: A factory for Query objects.
LuceneResultStruct<K,V> - Interface in org.apache.geode.cache.lucene: An interface which stores a single result obtained by executing a Lucene query.
LuceneSerializer<T> - Interface in org.apache.geode.cache.lucene: An interface for writing the fields of an object into a lucene document
LuceneService - Interface in org.apache.geode.cache.lucene: The LuceneService provides the capability to create Lucene indexes and execute lucene queries on data stored in Geode regions.
LuceneServiceMXBean - Interface in org.apache.geode.cache.lucene.management: MBean that provides access to the LuceneService.
LuceneServiceProvider - Class in org.apache.geode.cache.lucene: Class for retrieving or creating the currently running instance of the LuceneService.

N

name - Variable in class org.apache.geode.cache.lucene.management.configuration.Index.Field
name - Variable in class org.apache.geode.cache.lucene.management.configuration.Index
next() - Method in interface org.apache.geode.cache.lucene.PageableLuceneQueryResults: Get the next page of results.

O

org.apache.geode.cache.lucene - package org.apache.geode.cache.lucene: This package provides an integration with Apache Lucene that allows Geode regions to be indexed in a distributed Lucene index and queries using Lucene queries.
org.apache.geode.cache.lucene.management - package org.apache.geode.cache.lucene.management
org.apache.geode.cache.lucene.management.configuration - package org.apache.geode.cache.lucene.management.configuration

P

PageableLuceneQueryResults<K,V> - Interface in org.apache.geode.cache.lucene: This interface allows you to retrieve a page of query results at a time, using the PageableLuceneQueryResults.hasNext() and PageableLuceneQueryResults.next() methods.

R

REGION_VALUE_FIELD - Static variable in interface org.apache.geode.cache.lucene.LuceneService: A special field name that indicates that the entire region value should be indexed.

S

serializer - Variable in class org.apache.geode.cache.lucene.management.configuration.Index
setAnalyzer(String) - Method in class org.apache.geode.cache.lucene.management.configuration.Index.Field: Sets the value of the analyzer property.
setFields(String...) - Method in interface org.apache.geode.cache.lucene.LuceneIndexFactory: Set the list of fields to be indexed.
setFields(Map<String, Analyzer>) - Method in interface org.apache.geode.cache.lucene.LuceneIndexFactory: Set the list of fields to be indexed.
setLimit(int) - Method in interface org.apache.geode.cache.lucene.LuceneQueryFactory: Set maximum number of results for a query.
setLuceneSerializer(LuceneSerializer) - Method in interface org.apache.geode.cache.lucene.LuceneIndexFactory: Configure the way objects are converted to lucene documents for this lucene index
setName(String) - Method in class org.apache.geode.cache.lucene.management.configuration.Index.Field: Sets the value of the name property.
setName(String) - Method in class org.apache.geode.cache.lucene.management.configuration.Index: Sets the value of the name property.
setPageSize(int) - Method in interface org.apache.geode.cache.lucene.LuceneQueryFactory: Set page size for a query result.
setSerializer(DeclarableType) - Method in class org.apache.geode.cache.lucene.management.configuration.Index: Sets the value of the serializer property.
size() - Method in interface org.apache.geode.cache.lucene.PageableLuceneQueryResults: Total number of hits matching the Lucene query across all pages.

T

toDocuments(LuceneIndex, Object) - Method in class org.apache.geode.cache.lucene.FlatFormatSerializer: Recursively serialize each indexed field's value into a field of lucene document.
toDocuments(LuceneIndex, T) - Method in interface org.apache.geode.cache.lucene.LuceneSerializer: Add the fields of the given value to a set of documents Added fields should be marked with Field.Store.NO.
toString() - Method in class org.apache.geode.cache.lucene.management.LuceneIndexMetrics: Outputs the string message containing all the stats stored for the LuceneIndex

W

waitUntilFlushed(String, String, long, TimeUnit) - Method in interface org.apache.geode.cache.lucene.LuceneService: Wait until the current entries in cache are indexed.

A C D F G H I L N O P R S T W