Class FullTextSettings

java.lang.Object

org.h2.fulltext.FullTextSettings

final class FullTextSettings
extends Object

The global settings of a full text search.

Field Summary

Fields

Modifier and Type	Field	Description
private final WeakHashMap<Connection, SoftValuesHashMap<String, PreparedStatement>>	cache	The prepared statement cache.
private final HashSet<String>	ignoreList	The set of words not to index (stop words).
private final ConcurrentHashMap<Integer, IndexInfo>	indexes	The set of indexes in this database.
private boolean	initialized	Whether this instance has been initialized.
private static final HashMap<String, FullTextSettings>	SETTINGS	The settings of open indexes.
private String	whitespaceChars	The whitespace characters.
private final HashMap<String,Integer>	words	The set of words / terms.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FullTextSettings()	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	addIgnored(Iterable<String> words)	Amend set of ignored words
(package private) void	addIndexInfo(IndexInfo index)	Add an index.
void	addWord(String word, Integer id)	Register searchable word
void	clearIgnored()	Clear set of ignored words
void	clearWordList()	Clear set of searchable words
protected static void	closeAll()	Close all fulltext settings, freeing up memory.
(package private) String	convertWord(String word)	Convert a word to uppercase.
(package private) IndexInfo	getIndexInfo(int indexId)	Get the index information for the given index id.
private static String	getIndexPath(Connection conn)	Get the file system path.
(package private) static FullTextSettings	getInstance(Connection conn)	Get or create the fulltext settings for this database.
protected String	getWhitespaceChars()
Integer	getWordId(String word)	Get id for a searchable word
protected boolean	isInitialized()	Get the initialized flag.
private static String	normalizeWord(String word)
(package private) PreparedStatement	prepare(Connection conn, String sql)	Prepare a statement.
protected void	removeAllIndexes()	Remove all indexes from the settings.
protected void	removeIndexInfo(IndexInfo index)	Remove an index from the settings.
protected void	setInitialized(boolean b)	Set the initialized flag.
protected void	setWhitespaceChars(String whitespaceChars)

Methods inherited from class Object

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

Field Details

SETTINGS

private static final HashMap<String, FullTextSettings> SETTINGS

The settings of open indexes.

initialized

private boolean initialized

Whether this instance has been initialized.

ignoreList

private final HashSet<String> ignoreList

The set of words not to index (stop words).

words

private final HashMap<String,Integer> words

The set of words / terms.

indexes

private final ConcurrentHashMap<Integer, IndexInfo> indexes

The set of indexes in this database.

cache

private final WeakHashMap<Connection, SoftValuesHashMap<String, PreparedStatement>> cache

The prepared statement cache.

whitespaceChars

private String whitespaceChars

The whitespace characters.

Constructor Details

FullTextSettings

private FullTextSettings()

Create a new instance.

Method Details

clearIgnored

public void clearIgnored()

Clear set of ignored words

addIgnored

public void addIgnored(Iterable<String> words)

Amend set of ignored words

Parameters:

words - to add

clearWordList

public void clearWordList()

Clear set of searchable words

getWordId

public Integer getWordId(String word)

Get id for a searchable word

Parameters:

word - to find id for

Returns:

Integer id or null if word is not found

addWord

public void addWord(String word,
 Integer id)

Register searchable word

Parameters:

word - to register

id - to register with

getIndexInfo

IndexInfo getIndexInfo(int indexId)

Get the index information for the given index id.

Parameters:

indexId - the index id

Returns:

the index info

addIndexInfo

void addIndexInfo(IndexInfo index)

Add an index.

Parameters:

index - the index

convertWord

String convertWord(String word)

Convert a word to uppercase. This method returns null if the word is in the ignore list.

Parameters:

word - the word to convert and check

Returns:

the uppercase version of the word or null

getInstance

static FullTextSettings getInstance(Connection conn)
                             throws SQLException

Get or create the fulltext settings for this database.

Parameters:

conn - the connection

Returns:

the settings

Throws:

SQLException - on failure

getIndexPath

private static String getIndexPath(Connection conn)
                            throws SQLException

Get the file system path.

Parameters:

conn - the connection

Returns:

the file system path

Throws:

SQLException

prepare

PreparedStatement prepare(Connection conn,
 String sql)
                   throws SQLException

Prepare a statement. The statement is cached in a soft reference cache.

Parameters:

conn - the connection

sql - the statement

Returns:

the prepared statement

Throws:

SQLException - on failure

removeAllIndexes

protected void removeAllIndexes()

Remove all indexes from the settings.

removeIndexInfo

protected void removeIndexInfo(IndexInfo index)

Remove an index from the settings.

Parameters:

index - the index to remove

setInitialized

protected void setInitialized(boolean b)

Set the initialized flag.

Parameters:

b - the new value

isInitialized

protected boolean isInitialized()

Get the initialized flag.

Returns:

whether this instance is initialized

closeAll

protected static void closeAll()

Close all fulltext settings, freeing up memory.

setWhitespaceChars

protected void setWhitespaceChars(String whitespaceChars)

getWhitespaceChars

protected String getWhitespaceChars()

normalizeWord

private static String normalizeWord(String word)