org.jafer.interfaces
Interface Search

All Known Implementing Classes:
AbstractClient, Adaptor, DatabeanManager, JDBC, MySQLDatabean, QueryAdaptor, RecordAdaptor, SRWClient, TDSDatabean, ZClient

public interface Search

Methods for searching

Author:
Antony Corfield; Matthew Dovey; Colin Tatham

Method Summary
 java.lang.String[] getDatabases()
          Get databases currently searched
 int getNumberOfResults()
          Get number of results for last query
 int getNumberOfResults(java.lang.String databaseName)
          Get number of results from the named database for last query
 java.lang.Object getQuery()
          Get the last submitted query
 java.lang.String getResultSetName()
           
 JaferException getSearchException(java.lang.String database)
          If a search fails this method will return the JaferException for the specified database
 JaferException[] getSearchException(java.lang.String[] databases)
          If a search fails this method will return the JaferException for the specified databases
 boolean isParseQuery()
           
 void saveQuery(java.lang.String file)
           
 void setDatabases(java.lang.String database)
          Set database to search
 void setDatabases(java.lang.String[] databases)
          Set databases to search
 void setParseQuery(boolean parseQuery)
           
 void setResultSetName(java.lang.String resultSetName)
           
 int submitQuery(java.lang.Object query)
          Send query (can be in XML form)
 

Method Detail

setResultSetName

void setResultSetName(java.lang.String resultSetName)

getResultSetName

java.lang.String getResultSetName()

setDatabases

void setDatabases(java.lang.String database)
Set database to search

Parameters:
database - database

setDatabases

void setDatabases(java.lang.String[] databases)
Set databases to search

Parameters:
databases - databases

getDatabases

java.lang.String[] getDatabases()
Get databases currently searched

Returns:
databases

setParseQuery

void setParseQuery(boolean parseQuery)

isParseQuery

boolean isParseQuery()

submitQuery

int submitQuery(java.lang.Object query)
                throws JaferException
Send query (can be in XML form)

Returns:
number of records found
Throws:
JaferException

saveQuery

void saveQuery(java.lang.String file)
               throws JaferException
Throws:
JaferException

getNumberOfResults

int getNumberOfResults()
Get number of results for last query

Returns:
number of results

getNumberOfResults

int getNumberOfResults(java.lang.String databaseName)
Get number of results from the named database for last query

Returns:
number of results

getQuery

java.lang.Object getQuery()
Get the last submitted query

Returns:
query

getSearchException

JaferException getSearchException(java.lang.String database)
                                  throws JaferException
If a search fails this method will return the JaferException for the specified database

Parameters:
database - The name of the database to check
Returns:
null if no errors were found
Throws:
JaferException

getSearchException

JaferException[] getSearchException(java.lang.String[] databases)
                                    throws JaferException
If a search fails this method will return the JaferException for the specified databases

Parameters:
databases - The databases to search
Returns:
An empty array if no errors were found
Throws:
JaferException