IndexFactory

esc.index.IndexFactory
object IndexFactory

The IndexFactory opens and/or creates an index.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def createIndex(indexBase: String, indexName: String, similarityConfig: SimilarityConfig): Indexer

Creates a new index. Returns an exception if such a folder already exists.

Creates a new index. Returns an exception if such a folder already exists.

Value parameters

indexBase

The base folder for the index.

indexName

The name of the index.

similarityConfig

Optional. A SimilarityConfiguration.

Attributes

Returns

Returns a configurated Indexer object.

def createIndexWithDirectory(indexDirectory: Directory, similarityConfig: SimilarityConfig): Indexer

Creates a new index. Returns an exception if such a folder already exists.

Creates a new index. Returns an exception if such a folder already exists.

Value parameters

indexDirectory

Lucene Directory.

similarityConfig

Optional. A SimilarityConfiguration.

Attributes

Returns

Returns a configurated Indexer object.

def openIndex(indexBase: String, indexName: String, similarityConfig: SimilarityConfig): Indexer

Opens an existing index.

Opens an existing index.

Value parameters

indexBase

The base folder for the index.

indexName

The name of the index.

similarityConfig

Optional. A SimilarityConfiguration.

Attributes

Returns

Returns a configurated Indexer object.

def openIndexForSearch(indexBase: String, indexName: String, similarityConfig: SimilarityConfig, adrCheckStopWords: List[String], adrCheckHitWords: List[String]): Finder

Creates a Finder.

Creates a Finder.

Value parameters

adrCheckHitWords

Optional. List with hit words for the address search.

adrCheckStopWords

Optional. List with stop words for the address search.

indexBase

The base folder for the index.

indexName

The name of the index.

similarityConfig

Optional. A SimilarityConfiguration.

Attributes

Returns

Returns a configurated Finder object.

def openIndexForSearchWithDirectory(indexDirectory: Directory, similarityConfig: SimilarityConfig, adrCheckStopWords: List[String], adrCheckHitWords: List[String]): Finder

Creates a Finder.

Creates a Finder.

Value parameters

adrCheckHitWords

Optional. List with hit words for the address search.

adrCheckStopWords

Optional. List with stop words for the address search.

indexDirectory

A Lucene Directory.

similarityConfig

Optional. A SimilarityConfiguration.

Attributes

def openIndexWithDirectory(indexDirectory: Directory, similarityConfig: SimilarityConfig): Indexer

Opens an existing index.

Opens an existing index.

Value parameters

indexDirectory

Lucene Directory.

similarityConfig

Optional. A SimilarityConfiguration.

Attributes

Returns

Returns a configurated Indexer object.

def openOrCreateIndex(indexBase: String, indexName: String, similarityConfig: SimilarityConfig): Indexer

Opens an existing index, or creates the index if it does not already exist.

Opens an existing index, or creates the index if it does not already exist.

Value parameters

indexBase

The base folder for the index.

indexName

The name of the index.

similarityConfig

Optional. A SimilarityConfiguration.

Attributes

Returns

Returns a configurated Indexer object.