Package org.codelibs.fess.dict.protwords

Class ProtwordsFile

java.lang.Object

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

org.codelibs.fess.dict.protwords.ProtwordsFile

public class ProtwordsFile
extends DictionaryFile<ProtwordsItem>

Dictionary file for protected words. This class manages the reading, writing, and updating of protected words dictionary files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ProtwordsFile.ProtwordsUpdater	Updater class for processing protwords items during dictionary updates.

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
ProtwordsFile(String id, String path, Date timestamp)	Constructor for ProtwordsFile.

Method Summary

Modifier and Type	Method	Description
void	delete(ProtwordsItem item)	Deletes a dictionary item.
org.dbflute.optional.OptionalEntity<ProtwordsItem>	get(long id)	Retrieves a dictionary item by its ID.
String	getPath()	Gets the file path of this dictionary.
String	getSimpleName()	Gets the simple name of this dictionary file.
String	getType()	Gets the type identifier for this dictionary file.
void	insert(ProtwordsItem item)	Inserts a new dictionary item.
protected void	reload(ProtwordsFile.ProtwordsUpdater updater)	Reloads the dictionary file with the specified updater.
protected void	reload(ProtwordsFile.ProtwordsUpdater updater, InputStream in)	Reloads the dictionary file with the specified updater and input stream.
DictionaryFile.PagingList<ProtwordsItem>	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 the input stream.
void	update(ProtwordsItem 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

ProtwordsFile

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

Constructor for ProtwordsFile.

Parameters:

id - the file identifier

path - the file path

timestamp - the file timestamp

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<ProtwordsItem>

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<ProtwordsItem>

Returns:

the file path

get

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

Description copied from class: DictionaryFile

Retrieves a dictionary item by its ID.

Specified by:

get in class DictionaryFile<ProtwordsItem>

Parameters:

id - the item ID

Returns:

an optional containing the item if found

selectList

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

Description copied from class: DictionaryFile

Retrieves a paginated list of dictionary items.

Specified by:

selectList in class DictionaryFile<ProtwordsItem>

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(ProtwordsItem item)

Description copied from class: DictionaryFile

Inserts a new dictionary item.

Specified by:

insert in class DictionaryFile<ProtwordsItem>

Parameters:

item - the item to insert

update

public void update(ProtwordsItem item)

Description copied from class: DictionaryFile

Updates an existing dictionary item.

Specified by:

update in class DictionaryFile<ProtwordsItem>

Parameters:

item - the item to update

delete

public void delete(ProtwordsItem item)

Description copied from class: DictionaryFile

Deletes a dictionary item.

Specified by:

delete in class DictionaryFile<ProtwordsItem>

Parameters:

item - the item to delete

reload

protected void reload(ProtwordsFile.ProtwordsUpdater updater)

Reloads the dictionary file with the specified updater.

Parameters:

updater - the updater to use for processing items

reload

protected void reload(ProtwordsFile.ProtwordsUpdater updater,
 InputStream in)

Reloads the dictionary file with the specified updater and input stream.

Parameters:

updater - the updater to use for processing items

in - the input stream containing the file content

getSimpleName

public String getSimpleName()

Gets the simple name of this dictionary file.

Returns:

the simple name of the file

update

public void update(InputStream in)
            throws IOException

Updates the dictionary file with content from the input stream.

Parameters:

in - the input stream containing the new content

Throws:

IOException - if an I/O error occurs

toString

public String toString()

Overrides:

toString in class Object