org.licas.query

Class LicasDocSearch

java.lang.Object

org.licas.ServiceAdmin

org.licas.query.LicasDocSearch

All Implemented Interfaces:

LicasDocSearchDef

public class LicasDocSearch
extends ServiceAdmin
implements LicasDocSearchDef

Search over the contents of documents in specified folders. Note that this does not update any links between services or perform any other type of function. This currently only searches over the public web folder and sub-folders.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected PasswordHandler	passwordHandler The password handler
protected java.util.ArrayList<java.lang.String>	queryIDs List of IDs for queries currently being executed
protected ServiceSpec	serviceSpec Initialisation service specification

Fields inherited from class org.licas.ServiceAdmin

adminInfo, contractManager, keywordHandler, service, serviceAdminKey, services, serviceTypes, workInfo

Constructor Summary

Constructors

Constructor and Description
LicasDocSearch(Service theParent, PasswordHandler thePasswordHandler) Create a new instance of LicasDocSearch.

Method Summary

Modifier and Type	Method and Description
org.licas_xml.abs.Element	docSearch(java.lang.String queryEngine, int callTimeout, org.licas_xml.abs.Element request, ServiceLinks serverLinks) Query the server to parse documents to find matching information.
java.util.ArrayList<java.lang.String>	readUrlDocs(java.util.ArrayList<java.lang.String> fileList) Read a list of text documents from files or URLs and return the parsed text.

Methods inherited from class org.licas.ServiceAdmin

clearInstanceValues, createFullServiceMeta, createMetaForRepos, createServiceMeta, getAdminInfo, getContractManager, getInstanceValues, getKeywordHandler, getService, getService, getServiceClasses, getServiceNames, getServiceNames, getServiceNames, getServiceOrWrapper, getServiceType, getServiceTypes, removeAllServices, removeAllServices, removeService, removeService, setAdminInfo, setWorkInfo

Methods inherited from class java.lang.Object

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

Field Detail

queryIDs

protected java.util.ArrayList<java.lang.String> queryIDs

List of IDs for queries currently being executed

passwordHandler

protected PasswordHandler passwordHandler

The password handler

serviceSpec

protected ServiceSpec serviceSpec

Initialisation service specification

Constructor Detail

LicasDocSearch

public LicasDocSearch(Service theParent,
                      PasswordHandler thePasswordHandler)
               throws java.lang.Exception

Create a new instance of LicasDocSearch.

Parameters:

theParent - the parent service.

thePasswordHandler - the parent password handler.

Throws:

java.lang.Exception - any error.

Method Detail

docSearch

public org.licas_xml.abs.Element docSearch(java.lang.String queryEngine,
                                           int callTimeout,
                                           org.licas_xml.abs.Element request,
                                           ServiceLinks serverLinks)
                                    throws java.lang.Exception

Query the server to parse documents to find matching information. To be recognised by the default classes, the root request element should have the tag name of QueryConst.QUERYMODEL, or 'Query_Model'. This should then contain a description of the query request. For this default model, the XML request that is passed in needs to be parsed by a QueryParser parser into a QueryModel object, of the 'licas_text' package. This is what the default classes will then evaluate. The documentation describes the different fields in more detail.

Specified by:

docSearch in interface LicasDocSearchDef

Parameters:

queryEngine - the query engine type.

callTimeout - maximum time allowed for the call (in milliseconds).

request - the query request in XML format.

serverLinks - the ESB links information.

Returns:

any suitable matches to the request. These are stored inside of an element for each related service, with attributes to describe the service uuid and type.

Throws:

java.lang.Exception - any error.

readUrlDocs

public java.util.ArrayList<java.lang.String> readUrlDocs(java.util.ArrayList<java.lang.String> fileList)
                                                  throws java.lang.Exception

Read a list of text documents from files or URLs and return the parsed text.

Parameters:

fileList - list of file paths or URLs to read the document from.

Returns:

list of text-only documents, with any markup/formatting removed.

Throws:

java.lang.Exception - any error.