com.groupdocs.search.scaling

Class Indexer

java.lang.Object

com.groupdocs.search.scaling.Indexer

public abstract class Indexer
extends Object

Represents a service that manages the distribution of indexed documents across shards of the search network.

Constructor Summary

Constructors

Constructor and Description
Indexer()

Method Summary

Modifier and Type	Method and Description
abstract void	add(Document[] documents, String[] passwords, IndexingOptions options) Performs indexing operation.
abstract void	add(ExtractedData[] data, IndexingOptions options) Performs indexing operation.
abstract void	changeAttributes(AttributeChangeBatch batch, ChangeAttributesOptions options) Applies the specified batch of attribute changes to indexed documents without reindexing.
abstract void	delete(String[] documentKeys, DeleteOptions options) Deletes indexed documents.
abstract void	deleteAllData() Deletes all indexed data from all shards of the search network.
abstract AliasDictionary	getAliasDictionary(int shardIndex) Gets the alias dictionary.
abstract Alphabet	getAlphabet(int shardIndex) Gets the alphabet dictionary.
abstract String[]	getAttributes(String documentKey) Gets all the attributes associated with the specified indexed document.
abstract CharacterReplacementDictionary	getCharacterReplacementDictionary(int shardIndex) Gets the character replacement dictionary.
abstract DictionaryBase	getDictionary(DictionaryType dictionaryType, int shardIndex) Gets a dictionary from the specified shard.
abstract HomophoneDictionary	getHomophoneDictionary(int shardIndex) Gets the homophone dictionary.
abstract PasswordDictionary	getPasswordDictionary(int shardIndex) Gets the password dictionary.
abstract SpellingCorrector	getSpellingCorrector(int shardIndex) Gets the spelling corrector dictionary.
abstract StopWordDictionary	getStopWordDictionary(int shardIndex) Gets the stop word dictionary.
abstract SynonymDictionary	getSynonymDictionary(int shardIndex) Gets the synonym dictionary.
abstract void	optimize(OptimizeOptions options) Minimizes the number of index segments by merging them one with another.
abstract void	setDictionary(DictionaryBase dictionary) Sets a dictionary in all shards.
abstract void	setDictionary(DictionaryBase dictionary, int shardIndex) Sets a dictionary in the specified shard.
abstract void	synchronize(SynchronizeOptions options) Synchronizes the list of indexed documents with those on shards.

Methods inherited from class java.lang.Object

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

Constructor Detail

Indexer

public Indexer()

Method Detail

add

public abstract void add(Document[] documents,
                         String[] passwords,
                         IndexingOptions options)

Performs indexing operation. Indexing only from stream and structure is supported.

Parameters:

documents - The documents from file system, stream, or structure.

passwords - The document passwords.

options - The add options.

add

public abstract void add(ExtractedData[] data,
                         IndexingOptions options)

Performs indexing operation. Adds the extracted data to the search network.

Parameters:

data - The extracted data.

options - The indexing options.

changeAttributes

public abstract void changeAttributes(AttributeChangeBatch batch,
                                      ChangeAttributesOptions options)

Applies the specified batch of attribute changes to indexed documents without reindexing.

Parameters:

batch - The attribute change batch.

options - The change attributes options.

delete

public abstract void delete(String[] documentKeys,
                            DeleteOptions options)

Deletes indexed documents.

Parameters:

documentKeys - The keys of documents added from streams or structures.

options - The delete options.

deleteAllData

public abstract void deleteAllData()

Deletes all indexed data from all shards of the search network.

getAliasDictionary

public abstract AliasDictionary getAliasDictionary(int shardIndex)

Gets the alias dictionary.

Parameters:

shardIndex - The shard index.

Returns:

The dictionary.

getAlphabet

public abstract Alphabet getAlphabet(int shardIndex)

Gets the alphabet dictionary.

Parameters:

shardIndex - The shard index.

Returns:

The dictionary.

getAttributes

public abstract String[] getAttributes(String documentKey)

Gets all the attributes associated with the specified indexed document.

Parameters:

documentKey - The document key.

Returns:

The attributes associated with the specified indexed document.

getCharacterReplacementDictionary

public abstract CharacterReplacementDictionary getCharacterReplacementDictionary(int shardIndex)

Gets the character replacement dictionary.

Parameters:

shardIndex - The shard index.

Returns:

The dictionary.

getDictionary

public abstract DictionaryBase getDictionary(DictionaryType dictionaryType,
                                             int shardIndex)

Gets a dictionary from the specified shard.

Parameters:

dictionaryType - The dictionary type.

shardIndex - The shard index.

Returns:

The dictionary.

getHomophoneDictionary

public abstract HomophoneDictionary getHomophoneDictionary(int shardIndex)

Gets the homophone dictionary.

Parameters:

shardIndex - The shard index.

Returns:

The dictionary.

getPasswordDictionary

public abstract PasswordDictionary getPasswordDictionary(int shardIndex)

Gets the password dictionary.

Parameters:

shardIndex - The shard index.

Returns:

The dictionary.

getSpellingCorrector

public abstract SpellingCorrector getSpellingCorrector(int shardIndex)

Gets the spelling corrector dictionary.

Parameters:

shardIndex - The shard index.

Returns:

The dictionary.

getStopWordDictionary

public abstract StopWordDictionary getStopWordDictionary(int shardIndex)

Gets the stop word dictionary.

Parameters:

shardIndex - The shard index.

Returns:

The dictionary.

getSynonymDictionary

public abstract SynonymDictionary getSynonymDictionary(int shardIndex)

Gets the synonym dictionary.

Parameters:

shardIndex - The shard index.

Returns:

The dictionary.

optimize

public abstract void optimize(OptimizeOptions options)

Minimizes the number of index segments by merging them one with another. This operation improves search performance.

Parameters:

options - The optimize options.

setDictionary

public abstract void setDictionary(DictionaryBase dictionary)

Sets a dictionary in all shards.

Parameters:

dictionary - The dictionary.

setDictionary

public abstract void setDictionary(DictionaryBase dictionary,
                                   int shardIndex)

Sets a dictionary in the specified shard.

Parameters:

dictionary - The dictionary.

shardIndex - The shard index.

synchronize

public abstract void synchronize(SynchronizeOptions options)

Synchronizes the list of indexed documents with those on shards. This operation fixes issues with indexing and deletion of documents that resulted from communication problems with the search network nodes.

Parameters:

options - The synchronize options.