edu.arsc.multisearch.client
Class LuceneSearchToolkit

java.lang.Object
  extended by uk.org.ogsadai.client.toolkit.activity.RequestComponent
      extended by uk.org.ogsadai.client.toolkit.activity.Activity
          extended by edu.arsc.multisearch.client.SearchToolkit
              extended by edu.arsc.multisearch.client.LuceneSearchToolkit

public class LuceneSearchToolkit
extends SearchToolkit


Field Summary
 
Fields inherited from class edu.arsc.multisearch.client.SearchToolkit
index, max, min, mInputParams, mOutputParams, query
 
Constructor Summary
LuceneSearchToolkit()
          Constructs an activity with no inputs or outputs.
 
Method Summary
protected  java.lang.String generateXML()
           
 LuceneSearchToolkit getInstance()
          This allows forClass().getInstance() structure
 long getResultCount()
          TAKEN FROM OGSA-DAIL IndexedFileSearch Modified.
 uk.org.ogsadai.client.toolkit.activity.ActivityOutput getSearchStatus()
          TAKEN FROM OGSA-DAI: IndexedFileSearch Activity Gets the activity's search status output.
 
Methods inherited from class edu.arsc.multisearch.client.SearchToolkit
getDataOutput, setIndex, setMax, setMin, setQuery
 
Methods inherited from class uk.org.ogsadai.client.toolkit.activity.Activity
addInput, addOutput, addOutputs, getDataResourceID, getInputParameters, getOutputParameters, getOutputs, replaceSpecialCharacters, setDataResourceID, setInput
 
Methods inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent
getDataService, getName, getSession, setDataService, setSession
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LuceneSearchToolkit

public LuceneSearchToolkit()
Constructs an activity with no inputs or outputs.

Method Detail

getInstance

public LuceneSearchToolkit getInstance()
This allows forClass().getInstance() structure

Overrides:
getInstance in class SearchToolkit

getSearchStatus

public uk.org.ogsadai.client.toolkit.activity.ActivityOutput getSearchStatus()
TAKEN FROM OGSA-DAI: IndexedFileSearch Activity Gets the activity's search status output.

Overrides:
getSearchStatus in class SearchToolkit
Returns:
the search status.

getResultCount

public long getResultCount()
                    throws uk.org.ogsadai.client.toolkit.activity.NoActivityOutputException,
                           uk.org.ogsadai.client.toolkit.exception.DataFormatException
TAKEN FROM OGSA-DAIL IndexedFileSearch Modified. Gets the number of results as recorded in the search status output.

Returns:
number of search results.
Throws:
uk.org.ogsadai.client.toolkit.exception.DataFormatException - if the XML output data for the activity's output cannot be parsed.
uk.org.ogsadai.client.toolkit.activity.NoActivityOutputException - if there is no output data or the data has not yet been processed to this output or the activity that generates this output has not yet been executed.

generateXML

protected java.lang.String generateXML()
Overrides:
generateXML in class SearchToolkit