acp.store

Class DataStore

java.lang.Object

acp.store.DataStore

public class DataStore
extends java.lang.Object

DataStore is utilize as the Data layer component to handle operation that communicates with Database. It is designed in a way that the methods doing simple and reusable task.

Author:

Teo Kee Cheng

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INDEX_FOLDER_DIR
static java.lang.String	SENTENCE_PREFIX

Constructor Summary

Constructors

Constructor and Description
DataStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	closeSession() Close the session with Hibernate.
void	commitTransaction() Commit changes through Hibernate.
java.util.List<Entity>	getEntities(int sourceID) Retrieve entities of a source document by source ID.
Entity	getEntity(int entityID) Retrieve a entity by entity ID.
Paragraph	getParagraph(int paragraphID) Retrieve a paragraph by paragraph ID.
Paragraph	getParagraph(int sourceID, int parentOrder) Retrieve a paragraph by source ID and the order of the paragraph on the source.
java.util.List<Paragraph>	getParagraphs(int sourceID) Retrieve paragraphs of a source document by source ID.
Sentence	getSentence(int sentenceID) Retrieve a sentence by sentence ID.
Sentence	getSentence(int paragraphID, int parentOrder) Retrieve a sentence by paragraph ID and the order of the sentence on the paragraph.
java.util.List<Sentence>	getSentences(int paragraphID) Retrieve sentences of a paragraph by paragraph ID.
org.hibernate.Session	getSession() Get the current session.
Source	getSource(java.lang.Class classType, int id) Retrieve a source information by paragraph/entity ID and the class type.
Source	getSource(int id) Retrieve a source information by source ID.
Source	getSource(java.lang.String url) Retrieve a source information by source name.
void	removeAllDataAndIndexes() Remove all sentences, entities, paragraphs, and sources.
void	removeEntitiesAndIndexes(java.util.List<Entity> entities) Remove entities and the lucene index from the database.
void	removeParagraphs(int sourceID) Remove paragraphs of a source document by source ID.
void	removeSentencesAndIndexes(java.util.List<Sentence> sentences) Remove sentences and the lucene index from the database.
void	removeSource(int sourceID) Remove source information of a source document by source ID.
void	rollbackTransaction() Rollback a transaction with Hibernate.
java.util.List<Suggestion>	searchEntity(java.lang.String userInput, Preference prefs, boolean autoTrigger) Search a list of relevant entities by user input and user preferences.
java.util.List<Suggestion>	searchText(java.lang.String userInput, Preference prefs, boolean autoTrigger) Search a list of relevant suggestions by user input and user preferences.
void	startSession() Start a session with Hibernate.
void	startTransaction() Start a transaction with Hibernate.
int	storeEntity(Entity entity) Insert an entity object
int	storeMetadata(Source metadata) Insert a source object
int	storeParagraph(Paragraph paragraph) Insert a paragraph object
int	storeSentence(Sentence sentence) Insert a sentence object

Methods inherited from class java.lang.Object

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

Field Detail

SENTENCE_PREFIX

public static final java.lang.String SENTENCE_PREFIX

See Also:

Constant Field Values

INDEX_FOLDER_DIR

public static final java.lang.String INDEX_FOLDER_DIR

Constructor Detail

DataStore

public DataStore()

Method Detail

removeAllDataAndIndexes

public void removeAllDataAndIndexes()

Remove all sentences, entities, paragraphs, and sources.

removeParagraphs

public void removeParagraphs(int sourceID)

Remove paragraphs of a source document by source ID.

Parameters:

sourceID - source id of the source document.

removeSentencesAndIndexes

public void removeSentencesAndIndexes(java.util.List<Sentence> sentences)

Remove sentences and the lucene index from the database.

Parameters:

sentences - list of Sentence object to be removed.

removeEntitiesAndIndexes

public void removeEntitiesAndIndexes(java.util.List<Entity> entities)

Remove entities and the lucene index from the database.

Parameters:

entities - list of Entity object to be removed.

removeSource

public void removeSource(int sourceID)

Remove source information of a source document by source ID.

Parameters:

sourceID - source ID of the source document.

getParagraph

public Paragraph getParagraph(int paragraphID)

Retrieve a paragraph by paragraph ID.

Parameters:

paragraphID - paragraph ID of the source document.

Returns:

Paragraph object if exist, null if does not exist.

getParagraph

public Paragraph getParagraph(int sourceID,
                     int parentOrder)

Retrieve a paragraph by source ID and the order of the paragraph on the source.

Parameters:

sourceID - source ID of the source document.

parentOrder - order of the paragraph on the source.

Returns:

Paragraph object if exist, null if does not exist.

getParagraphs

public java.util.List<Paragraph> getParagraphs(int sourceID)

Retrieve paragraphs of a source document by source ID.

Parameters:

sourceID - source ID of the source document.

Returns:

non-empty List object if exist, empty List object if does not exist.

getEntity

public Entity getEntity(int entityID)

Retrieve a entity by entity ID.

Parameters:

entityID - entity ID of the source document.

Returns:

Entity object if exist, null if does not exist.

getEntities

public java.util.List<Entity> getEntities(int sourceID)

Retrieve entities of a source document by source ID.

Parameters:

sourceID - source ID of the source document.

Returns:

non-empty List object if exist, empty List object if does not exist.

getSentence

public Sentence getSentence(int sentenceID)

Retrieve a sentence by sentence ID.

Parameters:

sentenceID - sentence ID of the source document.

Returns:

Sentence object if exist, null if does not exist.

getSentence

public Sentence getSentence(int paragraphID,
                   int parentOrder)

Retrieve a sentence by paragraph ID and the order of the sentence on the paragraph.

Parameters:

paragraphID - paragraph ID of the paragraph document.

parentOrder - order of the sentence on the paragraph.

Returns:

Sentence object if exist, null if does not exist.

getSentences

public java.util.List<Sentence> getSentences(int paragraphID)

Retrieve sentences of a paragraph by paragraph ID.

Parameters:

paragraphID - paragraph ID of the paragraph.

Returns:

non-empty List object if exist, empty List object if does not exist.

getSource

public Source getSource(java.lang.String url)

Retrieve a source information by source name.

Parameters:

url - source name of the source document.

Returns:

source object if exist, null if does not exist.

getSource

public Source getSource(java.lang.Class classType,
               int id)

Retrieve a source information by paragraph/entity ID and the class type.

Parameters:

classType - class type of Paragraph/Entity class.

id - paragraph/entity ID.

Returns:

source object if exist, null if does not exist.

getSource

public Source getSource(int id)

Retrieve a source information by source ID.

Parameters:

id - source ID of the source document.

Returns:

source object if exist, null if does not exist.

searchText

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

Search a list of relevant suggestions by user input and user preferences.

Parameters:

userInput - search string input from the user.

prefs - user preferences of ACP.

Returns:

non-empty List object if result exist and is according to the preferences (Threshold setting), empty List object if result does not exist or is not according to the preferences (Threshold setting).

searchEntity

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

Search a list of relevant entities by user input and user preferences.

Parameters:

userInput - search string input from the user.

prefs - user preferences of ACP.

Returns:

non-empty List object if result exist and is according to the preferences (Threshold setting), empty List object if result does not exist or is not according to the preferences (Threshold setting).

storeEntity

public int storeEntity(Entity entity)

Insert an entity object

Parameters:

entity - entity object.

Returns:

entity ID if store succeed, -1 if store fail.

storeMetadata

public int storeMetadata(Source metadata)

Insert a source object

Parameters:

metadata - source object.

Returns:

source ID if store succeed, -1 if store fail.

storeParagraph

public int storeParagraph(Paragraph paragraph)

Insert a paragraph object

Parameters:

paragraph - paragraph object.

Returns:

paragraph ID if store succeed, -1 if store fail.

storeSentence

public int storeSentence(Sentence sentence)

Insert a sentence object

Parameters:

sentence - sentence object.

Returns:

sentence ID if store succeed, -1 if store fail.

startSession

public void startSession()

Start a session with Hibernate. Allows retrieval of data but not manipulation of data.

getSession

public org.hibernate.Session getSession()

Get the current session.

Returns:

the current session.

closeSession

public void closeSession()

Close the session with Hibernate.

startTransaction

public void startTransaction()

Start a transaction with Hibernate. Allows retrieval of data and manipulation of data.

commitTransaction

public void commitTransaction()

Commit changes through Hibernate. All changes made will be updated.

rollbackTransaction

public void rollbackTransaction()

Rollback a transaction with Hibernate. All changes made will be undo.