pt.ua.dicoogle.server.web.management

Class Indexer

java.lang.Object

pt.ua.dicoogle.server.web.management.Indexer

public class Indexer
extends java.lang.Object

A wrapper used to manage the indexer remotely through the web environment/app.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SETTING_DIRECTORY_MONITORIZATION_NAME The name of the setting that indicates the Dicoogle Directory Monitorization.
static java.lang.String	SETTING_INDEX_ZIP_FILES_NAME The name of the setting that indicates if ZIP files are to be Indexed.
static java.lang.String	SETTING_INDEXING_EFFORT_HELP The help of the Indexing Effort setting.
static java.lang.String	SETTING_INDEXING_EFFORT_NAME The name of the setting that indicates the Indexing Effort.
static java.lang.String	SETTING_SAVE_THUMBNAILS_NAME The name of the setting that indicates if Thumbnails are to be Saved.
static java.lang.String	SETTING_THUMBNAILS_SIZE_NAME The name of the setting that indicates the Thumbnails Size.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDicooglePath() Gets the Dicoogle indexing path.
static Indexer	getInstance() Returns the current instance of this class.
java.util.HashMap<java.lang.String,java.lang.Object>	getSettings() Returns a Map containing the current settings.
java.util.HashMap<java.lang.String,java.lang.String>	getSettingsHelp() Returns the settings help.
int	indexingPercentCompleted() Returns the current progress (percentual) of the indexing operation.
boolean	isIndexing() Returns if the Index Engine is currently indexing.
void	setDicooglePath(java.lang.String path) Sets the Dicoogle indexing path.
boolean	setSettings(java.util.HashMap<java.lang.String,java.lang.Object> settings) Tries to set the supplied settings as the new settings.
void	startIndexing() Starts the indexing process.
void	stopIndexing() Stops the indexing process.
boolean	trySettings(java.util.HashMap<java.lang.String,java.lang.Object> map) Validates the settings supplied and checks if they are valid ones.

Methods inherited from class java.lang.Object

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

Field Detail

SETTING_DIRECTORY_MONITORIZATION_NAME

public static final java.lang.String SETTING_DIRECTORY_MONITORIZATION_NAME

The name of the setting that indicates the Dicoogle Directory Monitorization.

See Also:

Constant Field Values

SETTING_INDEXING_EFFORT_NAME

public static final java.lang.String SETTING_INDEXING_EFFORT_NAME

The name of the setting that indicates the Indexing Effort.

See Also:

Constant Field Values

SETTING_THUMBNAILS_SIZE_NAME

public static final java.lang.String SETTING_THUMBNAILS_SIZE_NAME

The name of the setting that indicates the Thumbnails Size.

See Also:

Constant Field Values

SETTING_SAVE_THUMBNAILS_NAME

public static final java.lang.String SETTING_SAVE_THUMBNAILS_NAME

The name of the setting that indicates if Thumbnails are to be Saved.

See Also:

Constant Field Values

SETTING_INDEX_ZIP_FILES_NAME

public static final java.lang.String SETTING_INDEX_ZIP_FILES_NAME

The name of the setting that indicates if ZIP files are to be Indexed.

See Also:

Constant Field Values

SETTING_INDEXING_EFFORT_HELP

public static final java.lang.String SETTING_INDEXING_EFFORT_HELP

The help of the Indexing Effort setting.

See Also:

Constant Field Values

Method Detail

getInstance

public static Indexer getInstance()

Returns the current instance of this class.

Returns:

the current instance of this class.

getSettings

public java.util.HashMap<java.lang.String,java.lang.Object> getSettings()

Returns a Map containing the current settings.

Returns:

a Map containing the current settings.

setSettings

public boolean setSettings(java.util.HashMap<java.lang.String,java.lang.Object> settings)

Tries to set the supplied settings as the new settings.

Parameters:

settings - a Map containing the new settings.

Returns:

true if all settings were successfully changed to the ones supplied, false otherwise (no settings changed).

trySettings

public boolean trySettings(java.util.HashMap<java.lang.String,java.lang.Object> map)

Validates the settings supplied and checks if they are valid ones.

Parameters:

map - a Map containing the settings.

Returns:

true if all the settings are valid.

Throws:

InvalidSettingValueException - if at least one of the settings is invalid.

getSettingsHelp

public java.util.HashMap<java.lang.String,java.lang.String> getSettingsHelp()

Returns the settings help.

Returns:

a HashMap containing the setting help.

startIndexing

public void startIndexing()

Starts the indexing process.

stopIndexing

public void stopIndexing()

Stops the indexing process.

isIndexing

public boolean isIndexing()

Returns if the Index Engine is currently indexing.

Returns:

if the Index Engine is currently indexing.

indexingPercentCompleted

public int indexingPercentCompleted()

Returns the current progress (percentual) of the indexing operation.

Returns:

the current progress (percentual) of the indexing operation.

setDicooglePath

public void setDicooglePath(java.lang.String path)

Sets the Dicoogle indexing path.

Parameters:

path - the Dicoogle indexing path.

getDicooglePath

public java.lang.String getDicooglePath()

Gets the Dicoogle indexing path.

Returns:

the Dicoogle indexing path.