org.licas_text.def

Interface QueryDef

All Known Implementing Classes:

QueryMediator

public interface QueryDef

This defines the methods that should be implemented by a query engine. The interface allows any class to be integrated with the rest of the system.

Author:

Kieran Greer

Method Summary

Modifier and Type	Method and Description
org.licas_xml.abs.Element	executeQuery(org.licas_xml.abs.Element theQuery, java.lang.Object source) Execute a query over the source.
org.licas_xml.abs.Element	getStats() Retrieve statistics relating to the query process.

Method Detail

executeQuery

org.licas_xml.abs.Element executeQuery(org.licas_xml.abs.Element theQuery,
                                       java.lang.Object source)
                                throws java.lang.Exception

Execute a query over the source.

Parameters:

theQuery - the query specification in XML.

source - the source content. Typically String or XML-based.

Returns:

the reply as an Element.

Throws:

java.lang.Exception - any error.

getStats

org.licas_xml.abs.Element getStats()
                            throws java.lang.Exception

Retrieve statistics relating to the query process.

Returns:

the statistics in XL format.

Throws:

java.lang.Exception - any error.