com.sssw.search.api
Interface EbiQueryEngineDelegate

All Superinterfaces:

EbiDelegate

public interface EbiQueryEngineDelegate

extends EbiDelegate

The interface for Query Engine business delegate.

Fields inherited from interface com.sssw.fw.api.EbiDelegate

SERVICE_LOCAL, SERVICE_REMOTE

Method Summary

void	addRepository(EbiContext context, String repositoryName) Add a new repository to the Query Engine.
void	clear() Clear out any parameters set for this object via the setter methods.
void	clearRepository(EbiContext context, String repositoryName) Remove all the documents in the specified Query Engine repository.
String	getApiVersion() Gets the version descriptor of the Query Engine product API.
String	getHost() Get the host (name or IP address) of this Query Engine.
int	getIndexerStatus(int indexID) Get the status of a specific indexer.
int	getIndexPort() Get the index port used for this Query Engine.
String	getProductName() Get the name of the Query Engine product.
String	getProductVersion() Get the version of the Query Engine product
int	getQueryPort() Get the query port used for this Query Engine.
Collection	getRepositories(EbiContext context) Get the list of names of Query Engine repositories.
String	getStatusMessage(int status) Given a status/error code, get the message
long	getTotalDocs() Gets the total number of documents in the Query Engine.
String	getVendorName() Get the name of the Query Engine vendor.
int	importFiles(EbiContext context, String filterDirectory, String tempDirectory, String importFileName, String repository, String[] fileNames, boolean storeContents, boolean setSummaries, int[] retVals) Imports a set of files whose names are specified.
int	indexBuffer(EbiContext context, String strBuffer, String killDupsMode) Index the specified String buffer full of document data into the Query Engine.
int	indexFile(EbiContext context, String killDupsMode, String repository, String importFileName) Indexes the specified import file into the query engine.
boolean	isAlive() Determine if the Query Engine is running.
void	ping() Determine the state of the Query Engine.
void	reinitialize(EbiContext context) Remove all the documents in the Query Engine and reinitialize it.
void	removeDocuments(EbiContext context, String[] repositories, String[] docs, boolean byID) Remove the specified documents from the Query Engine.
void	removeRepository(EbiContext context, String repositoryName) Remove the specified Query Engine repository.
void	reset(EbiContext context) Reload the configuration settings for the Query Engine and reset it.
Collection	runQuery(EbiContext context, EbiQuery query, String[] repositories, boolean returnElements) Run the specified query.
void	setHost(String host) Set the host for this Query Engine object.
void	setIndexPort(int indexPort) Set the index port for this Query Engine object.
void	setQualifier(String qualifier) Set the qualifier for this Query Engine object.
void	setQueryPort(int queryPort) Set the query port for this Query Engine object.

Methods implemented from interface com.sssw.fw.api.EbiDelegate

getName

Method Detail

setQualifier

public void setQualifier(String qualifier)

Set the qualifier for this Query Engine object. This helps the object establish what context it's running in (e.g. CM). Not part of the public API.

Parameters:

qualifier - the contextual qualifier

getVendorName

public String getVendorName()

Get the name of the Query Engine vendor.

Returns:

vendor name

getProductName

public String getProductName()
                      throws EboUnrecoverableSystemException

Get the name of the Query Engine product.

Returns:

the Query Engine product name

getProductVersion

public String getProductVersion()
                         throws EboUnrecoverableSystemException

Get the version of the Query Engine product

Returns:

the version descriptor for the Query Engine product

getApiVersion

public String getApiVersion()
                     throws EboUnrecoverableSystemException

Gets the version descriptor of the Query Engine product API.

Returns:

the version descriptor of the Query Engine product API

getTotalDocs

public long getTotalDocs()
                  throws EboUnrecoverableSystemException

Gets the total number of documents in the Query Engine.

Returns:

the total number of documents in the Query Engine

setHost

public void setHost(String host)

Set the host for this Query Engine object.

Parameters:

host - the host name or IP address

setQueryPort

public void setQueryPort(int queryPort)

Set the query port for this Query Engine object.

Parameters:

queryPort - the query port to use

setIndexPort

public void setIndexPort(int indexPort)

Set the index port for this Query Engine object.

Parameters:

indexPort - the index port to use

clear

public void clear()

Clear out any parameters set for this object via the setter methods. This method does not affect the internal state of the Query Engine itself and is simply a convenience for object reuse.

getHost

public String getHost()

Get the host (name or IP address) of this Query Engine.

Returns:

the host

getQueryPort

public int getQueryPort()

Get the query port used for this Query Engine.

Returns:

the query port

getIndexPort

public int getIndexPort()

Get the index port used for this Query Engine.

Returns:

the index port

isAlive

public boolean isAlive()

Determine if the Query Engine is running.

Returns:

true if the engine is running, false otherwise

ping

public void ping()
          throws EboUnrecoverableSystemException

Determine the state of the Query Engine. If the engine is not running, an exception is thrown.

runQuery

public Collection runQuery(EbiContext context,
                           EbiQuery query,
                           String[] repositories,
                           boolean returnElements)
                    throws EboUnrecoverableSystemException,
                           EboSecurityException

Run the specified query.

Parameters:

context - context

query - the query to run

repositories - the set of Query Engine repositories to run the query against; if not specified, the query is run over all of the repositories

returnElements - if true, a Collection of EbiQueryResult's is returned, otherwise a Collection of Map's of document properties mapped to their values

Returns:

a Collection of EbiQueryResult's or Map's depending on the value of the returnElements parameter

indexBuffer

public int indexBuffer(EbiContext context,
                       String strBuffer,
                       String killDupsMode)
                throws EboUnrecoverableSystemException,
                       EboSecurityException

Index the specified String buffer full of document data into the Query Engine.

Parameters:

context - context

strBuffer - the buffer to index

killDupsMode - specifies how to deal with duplicates when indexing

Returns:

the ID of the indexer that is indexing the data

importFiles

public int importFiles(EbiContext context,
                       String filterDirectory,
                       String tempDirectory,
                       String importFileName,
                       String repository,
                       String[] fileNames,
                       boolean storeContents,
                       boolean setSummaries,
                       int[] retVals)
                throws EboUnrecoverableSystemException,
                       EboSecurityException

Imports a set of files whose names are specified.

Parameters:

context - context

filterDirectory - the directory where binary document filters are installed

tempDirectory - the temporary directory, if any, for the importer to use

importFileName - the filepath of the output import file; if the file does not exist, the method attempts to create it, if it exists, the method will overwrite it with the new output

repository - the name of the query engine repository that the imported files are intended for

fileNames - the filepaths of content files to be imported

storeContents - if true, contents are stored into the output file

setSummaries - if true, the import process automatically creates a summary field for for each document based on the first couple of sentences

retVals - an array of status/error codes, one per each of the files in the fileNames array

Returns:

status/error code for the operation

See Also:

EbiQueryEngineDelegate.indexFile(EbiContext, String, String, String), EbiQueryEngineDelegate.getStatusMessage(int)

indexFile

public int indexFile(EbiContext context,
                     String killDupsMode,
                     String repository,
                     String importFileName)
              throws EboUnrecoverableSystemException,
                     EboSecurityException

Indexes the specified import file into the query engine.

Parameters:

context - context

killDupsMode - specifies how to deal with duplicates when indexing

repository - the name of the query engine repository that the content in the import file is intended for

importFileName - the filepath to the import content file

Returns:

the ID of the indexer that is indexing the data

See Also:

EbiQueryEngineDelegate.importFiles(EbiContext, String, String, String, String, String[], boolean, boolean, int[]), EbiQueryEngineDelegate.getIndexerStatus(int)

getIndexerStatus

public int getIndexerStatus(int indexID)
                     throws EboUnrecoverableSystemException

Get the status of a specific indexer.

Parameters:

indexID - the index ID

Returns:

the status

getStatusMessage

public String getStatusMessage(int status)
                        throws EboUnrecoverableSystemException

Given a status/error code, get the message

Parameters:

status - the status to get the message for

Returns:

the status message

removeDocuments

public void removeDocuments(EbiContext context,
                            String[] repositories,
                            String[] docs,
                            boolean byID)
                     throws EboUnrecoverableSystemException,
                            EboSecurityException

Remove the specified documents from the Query Engine.

Parameters:

context - context

repositories - the names of Query Engine repositories to remove the documents in

docs - the ID's or references/URL's of documents to be removed

byID - if true, 'docs' is assumed to be an array of document ID's, otherwise an array of document references

getRepositories

public Collection getRepositories(EbiContext context)
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Get the list of names of Query Engine repositories.

Parameters:

context - context

Returns:

a Collection of String's each of which is a repository name

addRepository

public void addRepository(EbiContext context,
                          String repositoryName)
                   throws EboUnrecoverableSystemException,
                          EboSecurityException

Add a new repository to the Query Engine.

Parameters:

context - context

repositoryName - the name of the new repository

removeRepository

public void removeRepository(EbiContext context,
                             String repositoryName)
                      throws EboUnrecoverableSystemException,
                             EboSecurityException

Remove the specified Query Engine repository. This will remove all the documents in the repository and then remove the repository itself.

Parameters:

context - context

repositoryName - the repository name

clearRepository

public void clearRepository(EbiContext context,
                            String repositoryName)
                     throws EboUnrecoverableSystemException,
                            EboSecurityException

Remove all the documents in the specified Query Engine repository.

Parameters:

context - context

repositoryName - the repository name

reinitialize

public void reinitialize(EbiContext context)
                  throws EboUnrecoverableSystemException,
                         EboSecurityException

Remove all the documents in the Query Engine and reinitialize it.

Parameters:

context - context

reset

public void reset(EbiContext context)
           throws EboUnrecoverableSystemException,
                  EboSecurityException

Reload the configuration settings for the Query Engine and reset it.

Parameters:

context - context