org.openanzo.indexer
Class IndexerProperties

java.lang.Object
  org.openanzo.indexer.IndexerProperties

public class IndexerProperties
extends java.lang.Object

Configuration properties for the Indexing API

Author:

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

Field Summary

static java.lang.String	KEY_INDEX_ENABLED Key for property "org.openanzo.indexer.enabled" Should the indexer be enabled.
static java.lang.String	KEY_INDEXER_ASYNCHRONOUS Key for property "org.openanzo.indexer.async" Should indexer add items to index in an asynchronous manor Server: Embedded:
static java.lang.String	KEY_INDEXER_CLEAR Key for property "org.openanzo.indexer.indexClear" Clear the index on startup.
static java.lang.String	KEY_INDEXER_FACTORY_CLASS Key for property "org.openanzo.indexer.indexerFactoryType" The class name for the implementation of the indexer factory to use.
static java.lang.String	KEY_INDEXER_PAGE_SIZE Key for property "org.openanzo.indexer.pageSize" The index pagesize
static java.lang.String	KEY_INDEXER_REBUILD Key for property "org.openanzo.indexer.rebuildIndex" Should the indexer be rebuilt on startup.

Constructor Summary

IndexerProperties()

Method Summary

static boolean	getAsync(java.util.Properties properties) Get KEY_INDEXER_ASYNCHRONOUS property from properties
static boolean	getEnabled(java.util.Properties properties) Get KEY_INDEX_ENABLED property from properties
static boolean	getIndexClear(java.util.Properties properties) Get KEY_INDEXER_CLEAR property from properties
static java.lang.String	getIndexerFactoryType(java.util.Properties properties) Get KEY_INDEXER_FACTORY_CLASS property from properties
static int	getPageSize(java.util.Properties properties, int defaultValue) Get KEY_INDEXER_PAGE_SIZE property from properties
static boolean	getRebuildIndex(java.util.Properties properties) Get KEY_INDEXER_REBUILD property from properties
static void	setAsync(java.util.Properties properties, boolean async) Set KEY_INDEXER_ASYNCHRONOUS property to async in properties
static void	setEnabled(java.util.Properties properties, boolean enabled) Set KEY_INDEX_ENABLED property to enabled in properties
static void	setIndexClear(java.util.Properties properties, boolean indexClear) Set KEY_INDEXER_CLEAR property to indexClear in properties
static void	setIndexerFactoryType(java.util.Properties properties, java.lang.String indexerFactoryType) Set KEY_INDEXER_FACTORY_CLASS property to indexerFactoryType in properties
static void	setPageSize(java.util.Properties properties, int pageSize) Set KEY_INDEXER_PAGE_SIZE property to pageSize in properties
static void	setRebuildIndex(java.util.Properties properties, boolean rebuildIndex) Set KEY_INDEXER_REBUILD property to rebuildIndex in properties

Methods inherited from class java.lang.Object

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

Field Detail

KEY_INDEXER_FACTORY_CLASS

public static final java.lang.String KEY_INDEXER_FACTORY_CLASS

Key for property "org.openanzo.indexer.indexerFactoryType" The class name for the implementation of the indexer factory to use.

Server:The class name for the implementation of the indexer factory to use.

Embedded:See server.

Examples: org.openanzo.model.indexer.lucene.ModelIndexerFactory

See Also:

Constant Field Values

KEY_INDEXER_REBUILD

public static final java.lang.String KEY_INDEXER_REBUILD

Key for property "org.openanzo.indexer.rebuildIndex" Should the indexer be rebuilt on startup.

Server:When persistence is enabled and this property is true, the index will rebuild the indexer when the container is started.

Embedded:See server

See Also:

Constant Field Values

KEY_INDEXER_CLEAR

public static final java.lang.String KEY_INDEXER_CLEAR

Key for property "org.openanzo.indexer.indexClear" Clear the index on startup.

Server:When persistence is enabled and this property is true, the index will clear the indexer when the container is started.

Embedded:See server

See Also:

Constant Field Values

KEY_INDEX_ENABLED

public static final java.lang.String KEY_INDEX_ENABLED

Key for property "org.openanzo.indexer.enabled" Should the indexer be enabled.

Server:When persistence is enabled, the indexer allows for the use of text index predicates as part of Sparql queries.

Embedded:See server

See Also:

Constant Field Values

KEY_INDEXER_ASYNCHRONOUS

public static final java.lang.String KEY_INDEXER_ASYNCHRONOUS

Key for property "org.openanzo.indexer.async" Should indexer add items to index in an asynchronous manor

Server:

Embedded:

See Also:

Constant Field Values

KEY_INDEXER_PAGE_SIZE

public static final java.lang.String KEY_INDEXER_PAGE_SIZE

Key for property "org.openanzo.indexer.pageSize" The index pagesize

See Also:

Constant Field Values

Constructor Detail

IndexerProperties

public IndexerProperties()

Method Detail

getIndexerFactoryType

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

Get KEY_INDEXER_FACTORY_CLASS property from properties

Parameters:

properties - containing configuration data

Returns:

value of KEY_INDEXER_FACTORY_CLASS if not present

setIndexerFactoryType

public static void setIndexerFactoryType(java.util.Properties properties,
                                         java.lang.String indexerFactoryType)

Set KEY_INDEXER_FACTORY_CLASS property to indexerFactoryType in properties

Parameters:

properties - containing configuration data

indexerFactoryType - value for indexerFactoryType

getRebuildIndex

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

Get KEY_INDEXER_REBUILD property from properties

Parameters:

properties - containing configuration data

Returns:

value of KEY_INDEXER_REBUILD,or "false" if not present

setRebuildIndex

public static void setRebuildIndex(java.util.Properties properties,
                                   boolean rebuildIndex)

Set KEY_INDEXER_REBUILD property to rebuildIndex in properties

Parameters:

properties - containing configuration data

rebuildIndex - value for rebuildIndex

getIndexClear

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

Get KEY_INDEXER_CLEAR property from properties

Parameters:

properties - containing configuration data

Returns:

value of KEY_INDEXER_CLEAR,or "false" if not present

setIndexClear

public static void setIndexClear(java.util.Properties properties,
                                 boolean indexClear)

Set KEY_INDEXER_CLEAR property to indexClear in properties

Parameters:

properties - containing configuration data

indexClear - value for indexClear

getEnabled

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

Get KEY_INDEX_ENABLED property from properties

Parameters:

properties - containing configuration data

Returns:

value of KEY_INDEX_ENABLED,or "false" if not present

setEnabled

public static void setEnabled(java.util.Properties properties,
                              boolean enabled)

Set KEY_INDEX_ENABLED property to enabled in properties

Parameters:

properties - containing configuration data

enabled - value for enabled

getAsync

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

Get KEY_INDEXER_ASYNCHRONOUS property from properties

Parameters:

properties - containing configuration data

Returns:

value of KEY_INDEXER_ASYNCHRONOUS,or "false" if not present

setAsync

public static void setAsync(java.util.Properties properties,
                            boolean async)

Set KEY_INDEXER_ASYNCHRONOUS property to async in properties

Parameters:

properties - containing configuration data

async - value for async

getPageSize

public static int getPageSize(java.util.Properties properties,
                              int defaultValue)

Get KEY_INDEXER_PAGE_SIZE property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for pageSize

Returns:

value of KEY_INDEXER_PAGE_SIZEor defaultValue if not present

setPageSize

public static void setPageSize(java.util.Properties properties,
                               int pageSize)

Set KEY_INDEXER_PAGE_SIZE property to pageSize in properties

Parameters:

properties - containing configuration data

pageSize - value for pageSize