Package org.springframework.data.gemfire.search.lucene

Class LuceneAccessor

java.lang.Object
org.springframework.data.gemfire.search.lucene.support.LuceneOperationsSupport
org.springframework.data.gemfire.search.lucene.LuceneAccessor
All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean, LuceneOperations
Direct Known Subclasses:
LuceneAccessorSupport
public abstract class LuceneAccessor extends LuceneOperationsSupport implements org.springframework.beans.factory.InitializingBean
Deprecated.
To be removed in GemFire 10 integration
LuceneAccessor is an abstract class supporting implementations of the LuceneOperations interface encapsulating common functionality necessary to execute Lucene queries.
Since:
1.1.0
See Also:
  • InitializingBean
  • LuceneOperationsSupport
  • GemFireCache
  • Region
  • LuceneIndex
  • LuceneQuery
  • LuceneQueryFactory
  • LuceneService
  • LuceneServiceProvider

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static interface 
    LuceneAccessor.LuceneQueryExecutor<T>
    Deprecated.
     

  • Field Summary

    Fields inherited from interface org.springframework.data.gemfire.search.lucene.LuceneOperations

    DEFAULT_PAGE_SIZE, DEFAULT_RESULT_LIMIT

  • Constructor Summary

    Constructors
    Constructor
    Description
    LuceneAccessor()
    Deprecated.
    Constructs an uninitialized instance of LuceneAccessor.
    LuceneAccessor(String indexName, String regionPath)
    Deprecated.
    Constructs an instance of the LuceneAccessor initialized with the given Lucene index name and Region reference upon which Lucene queries are executed.
    LuceneAccessor(String indexName, org.apache.geode.cache.Region<?,?> region)
    Deprecated.
    Constructs an instance of the LuceneAccessor initialized with the given Lucene index name and Region reference upon which Lucene queries are executed.
    LuceneAccessor(org.apache.geode.cache.lucene.LuceneIndex luceneIndex)
    Deprecated.
    Constructs an instance of the LuceneAccessor initialized with the given LuceneIndex used to perform Lucene queries (searches).

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    afterPropertiesSet()
    Deprecated.
     
    org.apache.geode.cache.lucene.LuceneQueryFactory
    createLuceneQueryFactory()
    Deprecated.
    Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.
    org.apache.geode.cache.lucene.LuceneQueryFactory
    createLuceneQueryFactory(int resultLimit)
    Deprecated.
    Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.
    org.apache.geode.cache.lucene.LuceneQueryFactory
    createLuceneQueryFactory(int resultLimit, int pageSize)
    Deprecated.
    Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.
    protected <T> T
    doFind(LuceneAccessor.LuceneQueryExecutor<T> queryExecutor, Object query, String regionPath, String indexName)
    Deprecated.
     
    protected org.apache.geode.cache.GemFireCache
    getCache()
    Deprecated.
    Returns a reference to the GemFireCache.
    String
    getIndexName()
    Deprecated.
    Returns the name of the LuceneIndex used in Lucene queries.
    org.apache.geode.cache.lucene.LuceneIndex
    getLuceneIndex()
    Deprecated.
    Returns a reference to the LuceneIndex used in Lucene queries.
    protected org.apache.geode.cache.lucene.LuceneService
    getLuceneService()
    Deprecated.
    Returns a reference to the LuceneService used to perform Lucene query data access operations.
    org.apache.geode.cache.Region<?,?>
    getRegion()
    Deprecated.
    Returns a reference to the Region used to specify Lucene queries.
    String
    getRegionPath()
    Deprecated.
    Returns a fully-qualified pathname to the Region used to specify Lucene queries.
    protected org.apache.geode.cache.GemFireCache
    resolveCache()
    Deprecated.
    Resolves a reference to the GemFireCache.
    protected String
    resolveIndexName()
    Deprecated.
    Resolves the name of the LuceneIndex required in the Lucene data access, query operations when a LuceneIndex is not specifically provided.
    protected org.apache.geode.cache.lucene.LuceneService
    resolveLuceneService()
    Deprecated.
    Resolves the LuceneService used by this data access object to perform Lucene queries.
    protected org.apache.geode.cache.lucene.LuceneService
    resolveLuceneService(org.apache.geode.cache.GemFireCache gemfireCache)
    Deprecated.
    Resolves the LuceneService used by this data access object to perform Lucene queries.
    protected String
    resolveRegionPath()
    Deprecated.
    Resolves the fully-qualified pathname of the Region to which the Lucene data access, query operations are performed and the LuceneIndex is applied, when a region path is not specifically provided.
    <T extends LuceneAccessor>
    T
    setCache(org.apache.geode.cache.GemFireCache gemfireCache)
    Deprecated.
    Sets a reference to the GemFireCache.
    <T extends LuceneAccessor>
    T
    setIndexName(String indexName)
    Deprecated.
    Sets the name of the LuceneIndex used in Lucene queries.
    <T extends LuceneAccessor>
    T
    setLuceneIndex(org.apache.geode.cache.lucene.LuceneIndex luceneIndex)
    Deprecated.
    Sets a reference to the LuceneIndex used in Lucene queries.
    <T extends LuceneAccessor>
    T
    setLuceneService(org.apache.geode.cache.lucene.LuceneService luceneService)
    Deprecated.
    Sets a reference to the LuceneService used to perform Lucene query data access operations.
    <T extends LuceneAccessor>
    T
    setRegion(org.apache.geode.cache.Region<?,?> region)
    Deprecated.
    Sets a reference to the Region used to specify Lucene queries.
    <T extends LuceneAccessor>
    T
    setRegionPath(String regionPath)
    Deprecated.
    Sets a fully-qualified pathname to the Region used to specify Lucene queries.

    Methods inherited from class org.springframework.data.gemfire.search.lucene.support.LuceneOperationsSupport

    query, query, query, query, queryForKeys, queryForKeys, queryForValues, queryForValues

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.springframework.data.gemfire.search.lucene.LuceneOperations

    query, query, queryForKeys, queryForKeys, queryForValues, queryForValues

  • Constructor Details

    • LuceneAccessor

      public LuceneAccessor()
      Deprecated.
      Constructs an uninitialized instance of LuceneAccessor.

    • LuceneAccessor

      public LuceneAccessor(org.apache.geode.cache.lucene.LuceneIndex luceneIndex)
      Deprecated.
      Constructs an instance of the LuceneAccessor initialized with the given LuceneIndex used to perform Lucene queries (searches).
      Parameters:
      luceneIndex - LuceneIndex used in Lucene queries.
      See Also:
      • LuceneIndex

    • LuceneAccessor

      public LuceneAccessor(String indexName, org.apache.geode.cache.Region<?,?> region)
      Deprecated.
      Constructs an instance of the LuceneAccessor initialized with the given Lucene index name and Region reference upon which Lucene queries are executed.
      Parameters:
      indexName - String containing the name of the LuceneIndex used in Lucene queries.
      region - Region on which Lucene queries are executed.
      See Also:
      • Region

    • LuceneAccessor

      public LuceneAccessor(String indexName, String regionPath)
      Deprecated.
      Constructs an instance of the LuceneAccessor initialized with the given Lucene index name and Region reference upon which Lucene queries are executed.
      Parameters:
      indexName - String containing the name of the LuceneIndex used in Lucene queries.
      regionPath - String containing the name of the Region on which Lucene queries are executed.

  • Method Details

    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Deprecated.
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      Exception

    • createLuceneQueryFactory

      public org.apache.geode.cache.lucene.LuceneQueryFactory createLuceneQueryFactory()
      Deprecated.
      Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.
      Returns:
      an instance of the LuceneQueryFactory to create and execute Lucene queries.
      See Also:

    • createLuceneQueryFactory

      public org.apache.geode.cache.lucene.LuceneQueryFactory createLuceneQueryFactory(int resultLimit)
      Deprecated.
      Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.
      Parameters:
      resultLimit - limit to the number of results returned by the query.
      Returns:
      an instance of the LuceneQueryFactory to create and execute Lucene queries.
      See Also:

    • createLuceneQueryFactory

      public org.apache.geode.cache.lucene.LuceneQueryFactory createLuceneQueryFactory(int resultLimit, int pageSize)
      Deprecated.
      Creates an instance of the LuceneQueryFactory to create and execute Lucene queries.
      Parameters:
      resultLimit - limit to the number of results returned by the query.
      pageSize - number of results appearing on a single page.
      Returns:
      an instance of the LuceneQueryFactory to create and execute Lucene queries.
      See Also:

    • resolveCache

      protected org.apache.geode.cache.GemFireCache resolveCache()
      Deprecated.
      Resolves a reference to the GemFireCache.
      Returns:
      a reference to the single instance of the GemFireCache.
      See Also:

    • resolveLuceneService

      protected org.apache.geode.cache.lucene.LuceneService resolveLuceneService()
      Deprecated.
      Resolves the LuceneService used by this data access object to perform Lucene queries.
      Returns:
      a reference to the GemFireCache LuceneService.
      See Also:

    • resolveLuceneService

      protected org.apache.geode.cache.lucene.LuceneService resolveLuceneService(org.apache.geode.cache.GemFireCache gemfireCache)
      Deprecated.
      Resolves the LuceneService used by this data access object to perform Lucene queries.
      Parameters:
      gemfireCache - GemFireCache used to resolve the LuceneService.
      Returns:
      a reference to the GemFireCache LuceneService.
      Throws:
      IllegalArgumentException - if GemFireCache is null.
      See Also:
      • LuceneService
      • GemFireCache

    • resolveIndexName

      protected String resolveIndexName()
      Deprecated.
      Resolves the name of the LuceneIndex required in the Lucene data access, query operations when a LuceneIndex is not specifically provided.
      Returns:
      the name of the resolve LuceneIndex.
      Throws:
      IllegalStateException - if the name of the LuceneIndex cannot be resolved.
      See Also:

    • resolveRegionPath

      protected String resolveRegionPath()
      Deprecated.
      Resolves the fully-qualified pathname of the Region to which the Lucene data access, query operations are performed and the LuceneIndex is applied, when a region path is not specifically provided.
      Returns:
      a String containing the fully-qualified pathname of the Region on which the Lucene data access, query operations are performed and the LuceneIndex is applied.
      Throws:
      IllegalStateException - if the fully-qualified pathname of the Region cannot be resolved.
      See Also:

    • setCache

      public <T extends LuceneAccessor> T setCache(org.apache.geode.cache.GemFireCache gemfireCache)
      Deprecated.
      Sets a reference to the GemFireCache.
      Type Parameters:
      T - Class type of the LuceneAccessor.
      Parameters:
      gemfireCache - GemFireCache reference.
      Returns:
      this LuceneAccessor.
      See Also:
      • GemFireCache

    • getCache

      protected org.apache.geode.cache.GemFireCache getCache()
      Deprecated.
      Returns a reference to the GemFireCache.
      Returns:
      a reference to the GemFireCache.
      See Also:

    • setIndexName

      public <T extends LuceneAccessor> T setIndexName(String indexName)
      Deprecated.
      Sets the name of the LuceneIndex used in Lucene queries.
      Type Parameters:
      T - Class type of the LuceneAccessor.
      Parameters:
      indexName - String containing the name of the LuceneIndex.
      Returns:
      this LuceneAccessor.
      See Also:

    • getIndexName

      public String getIndexName()
      Deprecated.
      Returns the name of the LuceneIndex used in Lucene queries.
      Returns:
      a String containing the name of the LuceneIndex.
      See Also:

    • setLuceneIndex

      public <T extends LuceneAccessor> T setLuceneIndex(org.apache.geode.cache.lucene.LuceneIndex luceneIndex)
      Deprecated.
      Sets a reference to the LuceneIndex used in Lucene queries.
      Type Parameters:
      T - Class type of the LuceneAccessor.
      Parameters:
      luceneIndex - LuceneIndex used in Lucene data access, query operations.
      Returns:
      this LuceneAccessor.
      See Also:

    • getLuceneIndex

      public org.apache.geode.cache.lucene.LuceneIndex getLuceneIndex()
      Deprecated.
      Returns a reference to the LuceneIndex used in Lucene queries.
      Returns:
      a LuceneIndex used in Lucene data access, query operations.
      See Also:

    • setLuceneService

      public <T extends LuceneAccessor> T setLuceneService(org.apache.geode.cache.lucene.LuceneService luceneService)
      Deprecated.
      Sets a reference to the LuceneService used to perform Lucene query data access operations.
      Type Parameters:
      T - Class type of the LuceneAccessor.
      Parameters:
      luceneService - LuceneService used to perform Lucene queries.
      Returns:
      this LuceneAccessor.
      See Also:
      • LuceneService

    • getLuceneService

      protected org.apache.geode.cache.lucene.LuceneService getLuceneService()
      Deprecated.
      Returns a reference to the LuceneService used to perform Lucene query data access operations.
      Returns:
      a reference to the LuceneService used to perform Lucene queries.
      See Also:
      • LuceneService

    • setRegion

      public <T extends LuceneAccessor> T setRegion(org.apache.geode.cache.Region<?,?> region)
      Deprecated.
      Sets a reference to the Region used to specify Lucene queries.
      Type Parameters:
      T - Class type of the LuceneAccessor.
      Parameters:
      region - Region used to specify Lucene queries.
      Returns:
      this LuceneAccessor.
      See Also:

    • getRegion

      public org.apache.geode.cache.Region<?,?> getRegion()
      Deprecated.
      Returns a reference to the Region used to specify Lucene queries.
      Returns:
      a Region used to specify Lucene queries.
      See Also:

    • setRegionPath

      public <T extends LuceneAccessor> T setRegionPath(String regionPath)
      Deprecated.
      Sets a fully-qualified pathname to the Region used to specify Lucene queries.
      Type Parameters:
      T - Class type of the LuceneAccessor.
      Parameters:
      regionPath - String containing the fully-qualified pathname to the Region used to specify Lucene queries.
      Returns:
      this LuceneAccessor.
      See Also:

    • getRegionPath

      public String getRegionPath()
      Deprecated.
      Returns a fully-qualified pathname to the Region used to specify Lucene queries.
      Returns:
      a String containing the fully-qualified pathname to the Region used to specify Lucene queries.
      See Also:

    • doFind

      protected <T> T doFind(LuceneAccessor.LuceneQueryExecutor<T> queryExecutor, Object query, String regionPath, String indexName)
      Deprecated.