acp.manager

Class RankManager

java.lang.Object

acp.manager.RankManager

public class RankManager
extends java.lang.Object

RankManager is the component that contains the ranking algorithm for learning of user behavior that produces a ranking model for ranking of suggestions and handles the store component that does the storing and retrieval of past user behavior.

Author:

Ng Chin Hui

Constructor Summary

Constructors

Constructor and Description
RankManager() Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNewEntry(java.lang.String sourceDoc) Register the new source document into algorithm.
void	changeRanks(java.lang.String sourceDoc) Promote the rank of the source document being viewed by the user.
void	closeDebugUI() To disable debugUI
java.util.ArrayList<java.lang.Integer>	getDestinationDocumentList() Get the list of destination documents
java.util.ArrayList<java.util.ArrayList<RankEntry>>	getHighlistList() Get the list of low list.
java.util.ArrayList<java.util.ArrayList<RankEntry>>	getLowlistList() Get the list of high list.
java.util.ArrayList<RankEntry>	getRankingModel() Method is used when require user behavior for sorting of suggestions.
void	learnUserBehaviour(int lastUsedParagraph, int lastUsedSentence, java.lang.String sourceDoc) Increases the score of the most recently pasted suggestion of a particular source document.
void	removeAllRankData() Remove of all entries from the algorithm.
void	removeDestinationDocument(int destinationDoc) Removes the destination document entry from the algorithm as well as removes it's high and low list from the highlist-List and lowlist-List.
void	removeRankData(java.lang.String sourceDoc) Removal of the source document entry from the algorithm after the source document is closed.
void	resetData() For UI Testing purpose.
void	setDestinationDocument(int destinationDoc) Keep tracks of the active destination document.
void	showDebugUI() To enable the debugUI
void	storeUserBehavior() Store the data collected from the user behavior by the algorithm.
void	testing_mode() To enable testing mode for Unit testing.

Methods inherited from class java.lang.Object

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

Constructor Detail

RankManager

public RankManager()

Default Constructor. Initialize the variables and retrieve past user behavior.

Method Detail

testing_mode

public void testing_mode()

To enable testing mode for Unit testing. It will use different file for storing and retrieving of user behavior.

addNewEntry

public void addNewEntry(java.lang.String sourceDoc)

Register the new source document into algorithm. It will check if there are existing data and initialize with past user behavior data. Then after it is inserted into the correct position.

Parameters:

sourceDoc - the name of the source document

changeRanks

public void changeRanks(java.lang.String sourceDoc)

Promote the rank of the source document being viewed by the user. Used by sensor module.

Parameters:

sourceDoc - the name of the source document

learnUserBehaviour

public void learnUserBehaviour(int lastUsedParagraph,
                      int lastUsedSentence,
                      java.lang.String sourceDoc)

Increases the score of the most recently pasted suggestion of a particular source document. Updates the score of all source documents according to the turn of last usage(pasting) Also, promote the rank of the source document if it is in high priority list and keep track of the position of the suggestion in the source document.

Parameters:

lastUsedParagraph - the position of the paragraph in the source document

lastUsedSentence - the position of the sentence in the paragraph

sourceDoc - the name of the source document

removeRankData

public void removeRankData(java.lang.String sourceDoc)

Removal of the source document entry from the algorithm after the source document is closed.

Parameters:

sourceDoc - the name of the source document

removeAllRankData

public void removeAllRankData()

Remove of all entries from the algorithm.

storeUserBehavior

public void storeUserBehavior()

Store the data collected from the user behavior by the algorithm.

getRankingModel

public java.util.ArrayList<RankEntry> getRankingModel()

Method is used when require user behavior for sorting of suggestions. The method produces a ranking model for the sorting algorithm to use.

Returns:

a ranking model based on user behavior for sorting of suggestions

setDestinationDocument

public void setDestinationDocument(int destinationDoc)

Keep tracks of the active destination document. If the destination document is new, it will be registered.

Parameters:

destinationDoc - the ID of the destination document

removeDestinationDocument

public void removeDestinationDocument(int destinationDoc)

Removes the destination document entry from the algorithm as well as removes it's high and low list from the highlist-List and lowlist-List. Stores the data removed into reference list(i.e. 1st list in highlist-List and lowlist-List).

Parameters:

destinationDoc - the ID of the destination document

getLowlistList

public java.util.ArrayList<java.util.ArrayList<RankEntry>> getLowlistList()

Get the list of high list.

Returns:

the list of high list

getHighlistList

public java.util.ArrayList<java.util.ArrayList<RankEntry>> getHighlistList()

Get the list of low list.

Returns:

the list of low list

getDestinationDocumentList

public java.util.ArrayList<java.lang.Integer> getDestinationDocumentList()

Get the list of destination documents

Returns:

the list of destination documents

showDebugUI

public void showDebugUI()

To enable the debugUI

closeDebugUI

public void closeDebugUI()

To disable debugUI

resetData

public void resetData()

For UI Testing purpose. To reset the data for new set of test scenario.