acp

Class ACPLogic

java.lang.Object

java.util.Observable

acp.ACPLogic

public class ACPLogic
extends java.util.Observable

This component acts as a controller: receive requests from both the Java UI and the external Plugins, validate the input based on the business rules, and direct them to the appropriate managers for further processing.

Author:

Loke Yan Hao

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ACPLogic.State

Method Summary

Methods

Modifier and Type	Method and Description
void	changeRanks(java.lang.String sourceName) Update the ranking of the opening window (source document).
void	chooseSuggestion(Suggestion suggestion) To inform the system that user has selected a specific suggestion for machine learning purposes.
void	clearAllData() Clear all the extracted data from the database This method is called during the launching and the closing of Java ACP, and when ACPBackground detect that the Mozilla Firefox plugin is closed.
void	closeDestinationDocument(int id) Alert the rank manager when a text editor (eg.
void	closeSourceDocument(java.lang.String url) Remove all the text extracted from the specified opening window (source document).
boolean	editEnableDisableACP(Preference preference)
boolean	editUserPreference(Preference preference) Save the updated user preference to the configuration file.
ACPLogic.State	getCurrentState() Get the current state of ACP logic.
static ACPLogic	getInstance() Returns the reference to the single instance of ACPLogic.
java.lang.String	getPreferenceConfigurationFileAbsolutePath() Retrieve the absolute file path of the configuration file.
Preference	getUserPreference() Retrieve the user preference from the configuration file.
boolean	initialiseLibraries() Returns true if it is able to initialise all the libraries successfully.
void	processRawText(java.lang.String rawText, java.lang.String sourceName, java.lang.String url) Process and store the text extracted from opening windows (source document).
Suggestion	requestExtendSuggestion(int id, int type) Retrieve the next paragraph, sentence or word based on the current selected suggestion.
java.util.List<Suggestion>	requestSuggestion(java.lang.String userInput, boolean autoTrigger) Using prefix search to retrieve a list of suggestions based on the user input.
void	setDestinationDocument(int id) Inform MLManager the current destination document (eg.
void	storeUserBehaviors() Store the learned user behaviors to a file.
void	triggerDebugUI() Display the debug UI for Machine Learning.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ACPLogic getInstance()

Returns the reference to the single instance of ACPLogic.

This method is a standard method for singleton class

Returns:

the reference to the single instance of ACPLogic

initialiseLibraries

public boolean initialiseLibraries()

Returns true if it is able to initialise all the libraries successfully.

This method may return false if it is unable to initialise a certain library. If that is the case, the program cannot continue executing. The calling method should prompt an error message and quit the system.

Returns:

the result of this operation.

processRawText

public void processRawText(java.lang.String rawText,
                  java.lang.String sourceName,
                  java.lang.String url)

Process and store the text extracted from opening windows (source document). The rawText argument is the content of the source document. The sourceName argument is the human readable identity name of the source document. The URL argument is the unique identity to identify the source document.

This method does not return any result. However if an error occur, GateException is catch, and since this method is called by a background process, it will be ignored.

Parameters:

rawText - the content of the source document. For now, it must be HTML document.

sourceName - the name for the source document.

url - the unique identity locator to identify the source document.

requestSuggestion

public java.util.List<Suggestion> requestSuggestion(java.lang.String userInput,
                                           boolean autoTrigger)

Using prefix search to retrieve a list of suggestions based on the user input. If prefix search returns 0 result, it will perform entity search using the last word as the search keyword. The userInput argument is the text entered by user in a text-editor. If the autoTrigger argument is false, it will return all the suggestions retrieved. If the autoTrigger argument is true, it will only return the list of suggestions when the number of suggestions does not exceed the threshold specified in User Preference.

The result is sorted based on user preference from the PreferenceManager and the user behaviors learned by the machine learning algorithm. This method returns an empty list of suggestions if autoTrigger is true and the actual number of suggestion in the suggestion list exceed the threshold specified in User Preference (Suggestion Threshold).

Parameters:

userInput - the text entered by user in a text-editor.

autoTrigger - the trigger mode.

Returns:

a list of suggestions returned from either prefix search or entity search.

See Also:

Suggestion

chooseSuggestion

public void chooseSuggestion(Suggestion suggestion)

To inform the system that user has selected a specific suggestion for machine learning purposes. The sourceName argument is the selected suggestion's source name.

Parameters:

suggestion - the source name of the selected suggestion.

requestExtendSuggestion

public Suggestion requestExtendSuggestion(int id,
                                 int type)

Retrieve the next paragraph, sentence or word based on the current selected suggestion. The id argument denote which sentence/paragraph it will refer from. The type argument is the type that user wish to request. The type can be one of the following: paragraph, sentence or word.

Parameters:

id - the id of the sentence/paragraph it will refer from.

type - the type that user wish to extend next. (Refer to Suggestion constant variable)

Returns:

the next suggestion.

See Also:

Suggestion

closeSourceDocument

public void closeSourceDocument(java.lang.String url)

Remove all the text extracted from the specified opening window (source document). The sourceName argument is the name of the source document.

Parameters:

url - the name of the source document.

changeRanks

public void changeRanks(java.lang.String sourceName)

Update the ranking of the opening window (source document). Having a higher source document rank mean that the source document have higher sorting order, and will be listed at the top few entries in the auto-completion suggestion box.

This method is called by ACPBackground class to give higher ranking for source documents which are recently viewed.

Parameters:

sourceName - the source name of the source document.

getUserPreference

public Preference getUserPreference()

Retrieve the user preference from the configuration file.

This method always returns a preference object, whether or not the configuration file exists.

Returns:

the current user preference options.

See Also:

Preference

editUserPreference

public boolean editUserPreference(Preference preference)

Save the updated user preference to the configuration file. The preference argument contain the updated preference.

This method will return true if it successfully update the configuration file.

Parameters:

preference - the updated user preference options.

Returns:

the result of this operation.

editEnableDisableACP

public boolean editEnableDisableACP(Preference preference)

getPreferenceConfigurationFileAbsolutePath

public java.lang.String getPreferenceConfigurationFileAbsolutePath()

Retrieve the absolute file path of the configuration file. This method is necessary for the Text-editor plugin to observe the file to track configuration changes.

Returns:

the absolute file path to locate the configuration file.

storeUserBehaviors

public void storeUserBehaviors()

Store the learned user behaviors to a file. This method is called before the program exit.

clearAllData

public void clearAllData()

Clear all the extracted data from the database This method is called during the launching and the closing of Java ACP, and when ACPBackground detect that the Mozilla Firefox plugin is closed.

setDestinationDocument

public void setDestinationDocument(int id)

Inform MLManager the current destination document (eg. Microsoft Word Document) it is working on. This allows ACP to track the different context between documents in the Text Editor.

Parameters:

id - the unique identity to identify the document.

triggerDebugUI

public void triggerDebugUI()

Display the debug UI for Machine Learning. This function should not be called in the release version.

getCurrentState

public ACPLogic.State getCurrentState()

Get the current state of ACP logic. This method is used by the Systray UI to display the appropriate icons based on the state.

Returns:

the current ACP logic state.

See Also:

ACPLogic.State

closeDestinationDocument

public void closeDestinationDocument(int id)

Alert the rank manager when a text editor (eg. Microsoft Word) is exited.

Parameters:

id - the document id.