Package org.codelibs.fess.dict.synonym

Class SynonymFile

java.lang.Object

org.codelibs.fess.dict.DictionaryFile<SynonymItem>

org.codelibs.fess.dict.synonym.SynonymFile

public class SynonymFile
extends DictionaryFile<SynonymItem>

Manages a dictionary file for synonyms. This class handles reading, parsing, and updating files that contain synonym rules. The file format supports both explicit mappings (e.g., `a => b`) and equivalent synonyms (e.g., `a, b, c`). The class provides methods for retrieving, adding, updating, and deleting synonym items, as well as reloading the dictionary from its source file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	SynonymFile.SynonymUpdater	An inner class for updating the synonym file.

Nested classes/interfaces inherited from class org.codelibs.fess.dict.DictionaryFile

DictionaryFile.PagingList<E>

Field Summary

Fields inherited from class org.codelibs.fess.dict.DictionaryFile

dictionaryManager, id, path, timestamp

Constructor Summary

Constructors

Constructor	Description
SynonymFile(String id, String path, Date timestamp)	Constructs a new synonym file.

Method Summary

Modifier and Type	Method	Description
void	delete(SynonymItem item)	Deletes a dictionary item.
org.dbflute.optional.OptionalEntity<SynonymItem>	get(long id)	Retrieves a dictionary item by its ID.
String	getPath()	Gets the file path of this dictionary.
String	getSimpleName()	Returns the simple name of the dictionary file.
String	getType()	Gets the type identifier for this dictionary file.
void	insert(SynonymItem item)	Inserts a new dictionary item.
protected void	reload(SynonymFile.SynonymUpdater updater)	Reloads the synonym dictionary from its source file.
protected void	reload(SynonymFile.SynonymUpdater updater, InputStream in)	Reloads the synonym dictionary from an input stream.
DictionaryFile.PagingList<SynonymItem>	selectList(int offset, int size)	Retrieves a paginated list of dictionary items.
String	toString()
void	update(InputStream in)	Updates the dictionary file with content from an input stream.
void	update(SynonymItem item)	Updates an existing dictionary item.

Methods inherited from class org.codelibs.fess.dict.DictionaryFile

getId, getTimestamp, manager, writeOut

Methods inherited from class java.lang.Object

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

Constructor Details

SynonymFile

public SynonymFile(String id,
 String path,
 Date timestamp)

Constructs a new synonym file.

Parameters:

id - The unique identifier for this dictionary file.

path - The path to the dictionary file.

timestamp - The last modified timestamp of the file.

Method Details

getType

public String getType()

Description copied from class: DictionaryFile

Gets the type identifier for this dictionary file.

Specified by:

getType in class DictionaryFile<SynonymItem>

Returns:

the dictionary type

getPath

public String getPath()

Description copied from class: DictionaryFile

Gets the file path of this dictionary.

Overrides:

getPath in class DictionaryFile<SynonymItem>

Returns:

the file path

get

public org.dbflute.optional.OptionalEntity<SynonymItem> get(long id)

Description copied from class: DictionaryFile

Retrieves a dictionary item by its ID.

Specified by:

get in class DictionaryFile<SynonymItem>

Parameters:

id - the item ID

Returns:

an optional containing the item if found

selectList

public DictionaryFile.PagingList<SynonymItem> selectList(int offset,
 int size)

Description copied from class: DictionaryFile

Retrieves a paginated list of dictionary items.

Specified by:

selectList in class DictionaryFile<SynonymItem>

Parameters:

offset - the starting offset for pagination

size - the number of items to retrieve

Returns:

a paginated list of dictionary items

insert

public void insert(SynonymItem item)

Description copied from class: DictionaryFile

Inserts a new dictionary item.

Specified by:

insert in class DictionaryFile<SynonymItem>

Parameters:

item - the item to insert

update

public void update(SynonymItem item)

Description copied from class: DictionaryFile

Updates an existing dictionary item.

Specified by:

update in class DictionaryFile<SynonymItem>

Parameters:

item - the item to update

delete

public void delete(SynonymItem item)

Description copied from class: DictionaryFile

Deletes a dictionary item.

Specified by:

delete in class DictionaryFile<SynonymItem>

Parameters:

item - the item to delete

reload

protected void reload(SynonymFile.SynonymUpdater updater)

Reloads the synonym dictionary from its source file.

Parameters:

updater - An optional updater to apply changes during reload.

Throws:

DictionaryException - if the dictionary file cannot be read.

reload

protected void reload(SynonymFile.SynonymUpdater updater,
 InputStream in)

Reloads the synonym dictionary from an input stream.

Parameters:

updater - An optional updater to apply changes.

in - The input stream to read the dictionary from.

Throws:

DictionaryException - if the input stream cannot be parsed.

getSimpleName

public String getSimpleName()

Returns the simple name of the dictionary file.

Returns:

The file name without the path.

update

public void update(InputStream in)
            throws IOException

Updates the dictionary file with content from an input stream.

Parameters:

in - The input stream containing the new dictionary content.

Throws:

IOException - if an I/O error occurs.

toString

public String toString()

Overrides:

toString in class Object