au.com.cybersearch2.classyfts

Class FtsEngine

java.lang.Object

au.com.cybersearch2.classyfts.FtsEngine

All Implemented Interfaces:

FtsQuery

public class FtsEngine
extends Object
implements FtsQuery

FtsEngine Fast text search engine with dictionary. Contains logic to return specific words from the dictionary, and load the dictionary table when it needs to be created.

Author:

Andrew Bowley 27/04/2014

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FtsEngine.FtsStatus FtsStatus - dictionary states initial, loading, loaded and error

Constructor Summary

Constructors

Constructor and Description
FtsEngine(FtsOpenHelper ftsOpenHelper, String targetTable, Map<String,String> targetColumnMap) Construct an FtsEngine

Method Summary

Methods

Modifier and Type	Method and Description
FtsEngine.FtsStatus	getStatus() Returns Engine status
FtsEngine.FtsStatus	initialize() Populates FTS dictionary.
android.database.Cursor	query(String selection, String[] selectionArgs, String[] columns, int limit) Performs a database query.
void	setOrderbyText2(boolean value) Set flag for "order by second column"
void	setText1Filter(WordFilter text1Filter) Set word filter for column 1
void	setText2Filter(WordFilter text2Filter) Set word filter for column 2

Methods inherited from class java.lang.Object

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

Constructor Detail

FtsEngine

public FtsEngine(FtsOpenHelper ftsOpenHelper,
         String targetTable,
         Map<String,String> targetColumnMap)

Construct an FtsEngine

Parameters:

ftsOpenHelper - SQLiteOpenHelper concrete implementation

targetTable - Table from which to select words in source database

targetColumnMap - Map of Engine column names to target database column names

Method Detail

initialize

public FtsEngine.FtsStatus initialize()

Populates FTS dictionary. This is a potentially long-running operation that should run on a background thread.

Returns:

FtsStatus Final status "Loaded" or "Error"

query

public android.database.Cursor query(String selection,
                            String[] selectionArgs,
                            String[] columns,
                            int limit)

Performs a database query.

Specified by:

query in interface FtsQuery

Parameters:

selection - The selection clause

selectionArgs - Selection arguments for "?" components in the selection

columns - The columns to return

limit - Maximum number of hits to return or unlimited if zero

Returns:

A Cursor over all rows matching the query

getStatus

public FtsEngine.FtsStatus getStatus()

Returns Engine status

Returns:

FtsStatus

setOrderbyText2

public void setOrderbyText2(boolean value)

Set flag for "order by second column"

Parameters:

value - boolean

setText1Filter

public void setText1Filter(WordFilter text1Filter)

Set word filter for column 1

Parameters:

text1Filter - WordFilter

setText2Filter

public void setText2Filter(WordFilter text2Filter)

Set word filter for column 2

Parameters:

text2Filter - WordFilter