org.openanzo.indexer.lucene
Class LuceneProperties

java.lang.Object
  org.openanzo.indexer.lucene.LuceneProperties

public class LuceneProperties
extends java.lang.Object

Configuration properties for the Lucene index

Author:

Generated Source from org.openanzo.utils.properties.jet

Field Summary

static java.lang.String	KEY_LUCENE_INDEX_LOCATION Key for property "org.openanzo.indexer.lucene.indexLocation" Location of the Lucene index on disk Server:When persistence is enabled on the server, this property points to the location of the Lucene index on disk. Client:The client uses its own Lucene index, so this property is not used. Embedded:See server
static java.lang.String	KEY_LUCENE_QUERY_FIELD Key for property "org.openanzo.indexer.lucene.field" Default field in index that is queried Server:This is the default field in the index that is queried. Client:The client uses its own Lucene index, so this property is not used. Embedded:See server
static java.lang.String	KEY_LUCENE_QUERY_TEXT Key for property "org.openanzo.indexer.lucene.text" Default query text Server:This is the default query text to use. Client:The client uses its own Lucene index, so this property is not used. Embedded:See server
static java.lang.String	KEY_LUCENE_REMOVE_LOCK_FILE Key for property "org.openanzo.indexer.lucene.removeLockFile" Force a removal of a previous lock file on startup.

Constructor Summary

LuceneProperties()

Method Summary

static java.lang.String	getField(java.util.Properties properties) Get KEY_LUCENE_QUERY_FIELD property from properties
static java.lang.String	getIndexLocation(java.util.Properties properties) Get KEY_LUCENE_INDEX_LOCATION property from properties
static boolean	getRemoveLockFile(java.util.Properties properties) Get KEY_LUCENE_REMOVE_LOCK_FILE property from properties
static java.lang.String	getText(java.util.Properties properties) Get KEY_LUCENE_QUERY_TEXT property from properties
static void	setField(java.util.Properties properties, java.lang.String field) Set KEY_LUCENE_QUERY_FIELD property to field in properties
static void	setIndexLocation(java.util.Properties properties, java.lang.String indexLocation) Set KEY_LUCENE_INDEX_LOCATION property to indexLocation in properties
static void	setRemoveLockFile(java.util.Properties properties, boolean removeLockFile) Set KEY_LUCENE_REMOVE_LOCK_FILE property to removeLockFile in properties
static void	setText(java.util.Properties properties, java.lang.String text) Set KEY_LUCENE_QUERY_TEXT property to text in properties

Methods inherited from class java.lang.Object

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

Field Detail

KEY_LUCENE_INDEX_LOCATION

public static final java.lang.String KEY_LUCENE_INDEX_LOCATION

Key for property "org.openanzo.indexer.lucene.indexLocation" Location of the Lucene index on disk

Server:When persistence is enabled on the server, this property points to the location of the Lucene index on disk.

Client:The client uses its own Lucene index, so this property is not used.

Embedded:See server

See Also:

Constant Field Values

KEY_LUCENE_QUERY_FIELD

public static final java.lang.String KEY_LUCENE_QUERY_FIELD

Key for property "org.openanzo.indexer.lucene.field" Default field in index that is queried

Server:This is the default field in the index that is queried.

Client:The client uses its own Lucene index, so this property is not used.

Embedded:See server

See Also:

Constant Field Values

KEY_LUCENE_QUERY_TEXT

public static final java.lang.String KEY_LUCENE_QUERY_TEXT

Key for property "org.openanzo.indexer.lucene.text" Default query text

Server:This is the default query text to use.

Client:The client uses its own Lucene index, so this property is not used.

Embedded:See server

See Also:

Constant Field Values

KEY_LUCENE_REMOVE_LOCK_FILE

public static final java.lang.String KEY_LUCENE_REMOVE_LOCK_FILE

Key for property "org.openanzo.indexer.lucene.removeLockFile" Force a removal of a previous lock file on startup.

Server:When persistence is enabled on the server and this property is true, the index will remove any previous Lucene lock files on disk.

Client:The client uses its own Lucene index, so this property is not used.

Embedded:See server

See Also:

Constant Field Values

Constructor Detail

LuceneProperties

public LuceneProperties()

Method Detail

getIndexLocation

public static java.lang.String getIndexLocation(java.util.Properties properties)

Get KEY_LUCENE_INDEX_LOCATION property from properties

Parameters:

properties - containing configuration data

Returns:

value of KEY_LUCENE_INDEX_LOCATION if not present

setIndexLocation

public static void setIndexLocation(java.util.Properties properties,
                                    java.lang.String indexLocation)

Set KEY_LUCENE_INDEX_LOCATION property to indexLocation in properties

Parameters:

properties - containing configuration data

indexLocation - value for indexLocation

getField

public static java.lang.String getField(java.util.Properties properties)

Get KEY_LUCENE_QUERY_FIELD property from properties

Parameters:

properties - containing configuration data

Returns:

value of KEY_LUCENE_QUERY_FIELD if not present

setField

public static void setField(java.util.Properties properties,
                            java.lang.String field)

Set KEY_LUCENE_QUERY_FIELD property to field in properties

Parameters:

properties - containing configuration data

field - value for field

getText

public static java.lang.String getText(java.util.Properties properties)

Get KEY_LUCENE_QUERY_TEXT property from properties

Parameters:

properties - containing configuration data

Returns:

value of KEY_LUCENE_QUERY_TEXT if not present

setText

public static void setText(java.util.Properties properties,
                           java.lang.String text)

Set KEY_LUCENE_QUERY_TEXT property to text in properties

Parameters:

properties - containing configuration data

text - value for text

getRemoveLockFile

public static boolean getRemoveLockFile(java.util.Properties properties)

Get KEY_LUCENE_REMOVE_LOCK_FILE property from properties

Parameters:

properties - containing configuration data

Returns:

value of KEY_LUCENE_REMOVE_LOCK_FILE,or "true" if not present

setRemoveLockFile

public static void setRemoveLockFile(java.util.Properties properties,
                                     boolean removeLockFile)

Set KEY_LUCENE_REMOVE_LOCK_FILE property to removeLockFile in properties

Parameters:

properties - containing configuration data

removeLockFile - value for removeLockFile