Esri Geoportal Server
1.0

com.esri.gpt.catalog.lucene
Class LuceneConfig

java.lang.Object
  extended by com.esri.gpt.catalog.lucene.LuceneConfig

public class LuceneConfig
extends Object

Maintains configuration information associated with a Lucene based index.


Constructor Summary
LuceneConfig()
          Default constructor.
 
Method Summary
 String getAnalyzerClassName()
          Gets the class name for the analyzer.
 String getIndexLocation()
          Gets the location of the folder that will hold the Lucene index for the catalog.
 int getMaxClauseCount()
          Gets maximum number of clauses within boolean query.
 Map<String,IParserProxy> getParserProxies()
          Gets parser proxies.
 boolean getUseConstantScoreQuery()
          Gets flag indicating if use constant score query instead of prefix query
 boolean getUseNativeFSLockFactory()
          Gets the flag indicating if a NativeFSLockFactory should be used.
 int getWriteLockTimeout()
          Gets the write lock timeout in milli-seconds.
 void setAnalyzerClassName(String className)
          Sets the class name for the analyzer.
 void setIndexLocation(String path)
          Sets the location of the folder that will hold the Lucene index for the catalog.
 void setMaxClauseCount(int maxClauseCount)
          Sets maximum number of clauses within boolean query.
 void setParserProxies(Map<String,IParserProxy> parserProxies)
          Sets parser proxies.
 void setUseConstantScoreQuery(boolean useConstantScoreQuery)
          Sets flag indicating if use constant score query instead of prefix query
 void setUseNativeFSLockFactory(boolean useNative)
          Sets the flag indicating if a NativeFSLockFactory should be used.
 void setWriteLockTimeout(int millis)
          Sets the write lock timeout in milli-seconds.
 String toString()
          Returns the string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LuceneConfig

public LuceneConfig()
Default constructor.

Method Detail

getAnalyzerClassName

public String getAnalyzerClassName()
Gets the class name for the analyzer.

Returns:
the analyzer class name

setAnalyzerClassName

public void setAnalyzerClassName(String className)
Sets the class name for the analyzer.

Parameters:
className - the analyzer class name

getIndexLocation

public String getIndexLocation()
Gets the location of the folder that will hold the Lucene index for the catalog.

Returns:
the catalog index location

setIndexLocation

public void setIndexLocation(String path)
Sets the location of the folder that will hold the Lucene index for the catalog.

Parameters:
path - the catalog index location

getParserProxies

public Map<String,IParserProxy> getParserProxies()
Gets parser proxies.

Returns:
collection (map) of parser proxies

setParserProxies

public void setParserProxies(Map<String,IParserProxy> parserProxies)
Sets parser proxies.

Parameters:
parserProxies - collection (map) of parser proxies

getUseNativeFSLockFactory

public boolean getUseNativeFSLockFactory()
Gets the flag indicating if a NativeFSLockFactory should be used.

Returns:
true if a NativeFSLockFactory should be used, otherwise use a SimpleFSLockFactory

setUseNativeFSLockFactory

public void setUseNativeFSLockFactory(boolean useNative)
Sets the flag indicating if a NativeFSLockFactory should be used.

Parameters:
useNative - true if a NativeFSLockFactory should be used, otherwise use a SimpleFSLockFactory

getWriteLockTimeout

public int getWriteLockTimeout()
Gets the write lock timeout in milli-seconds.

Returns:
the write lock timeout

setWriteLockTimeout

public void setWriteLockTimeout(int millis)
Sets the write lock timeout in milli-seconds.
If the timout is less than zero, the timeout will be set to 60000.

Parameters:
millis - the write lock timeout the write lock timeout

getUseConstantScoreQuery

public boolean getUseConstantScoreQuery()
Gets flag indicating if use constant score query instead of prefix query

Returns:
true to use constant score query

setUseConstantScoreQuery

public void setUseConstantScoreQuery(boolean useConstantScoreQuery)
Sets flag indicating if use constant score query instead of prefix query

Parameters:
useConstantScoreQuery - true to use constant score query

getMaxClauseCount

public int getMaxClauseCount()
Gets maximum number of clauses within boolean query.

Returns:
maximum number of clauses within boolean query

setMaxClauseCount

public void setMaxClauseCount(int maxClauseCount)
Sets maximum number of clauses within boolean query.

Parameters:
maxClauseCount - maximum number of clauses within boolean query

toString

public String toString()
Returns the string representation of the object.

Overrides:
toString in class Object
Returns:
the string

Esri Geoportal Server
1.0

Copyright 2011 Environmental Systems Research Institute. All rights reserved. Use is subject to license terms.