edu.arsc.multisearch.client
Class SearchToolkit

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
Direct Known Subclasses:
LuceneSearchToolkit

public class SearchToolkit
extends uk.org.ogsadai.client.toolkit.activity.Activity


Field Summary
protected static int DATA_OUTPUT_INDEX
          Index of search data output
protected  java.lang.String index
          The index associated with this search.
protected  int max
          The maximum number of results from this activity.
protected  int min
          The minimum number of results from this activity.
protected  java.util.List mInputParams
          A list of the activity's input parameters (ActivityInputParameter)
protected  java.util.List mOutputParams
          A list of the activity's output parameters (ActivityOuyputParameter)
protected  java.lang.String query
          The query object associated with this search.
protected static int STATUS_OUTPUT_INDEX
          Index of search status output
 
Constructor Summary
SearchToolkit()
          Constructs an activity with no inputs or outputs.
 
Method Summary
protected  java.lang.String generateXML()
           
 uk.org.ogsadai.client.toolkit.activity.ActivityOutput getDataOutput()
          Gets the activity's data output.
 SearchToolkit getInstance()
          This allows forClass().getInstance() structure
 uk.org.ogsadai.client.toolkit.activity.ActivityOutput getSearchStatus()
          Gets the activity's search status output.
 void setIndex(java.lang.String index)
          Set the index of this search, if there is one (might be NULL)
 void setMax(int max)
          Set the Maximum result limit.
 void setMin(int min)
          Set the Minimum result requirement.
 void setQuery(java.lang.String query)
          Set the query, string.
 
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
 

Field Detail

DATA_OUTPUT_INDEX

protected static final int DATA_OUTPUT_INDEX
Index of search data output

See Also:
Constant Field Values

STATUS_OUTPUT_INDEX

protected static final int STATUS_OUTPUT_INDEX
Index of search status output

See Also:
Constant Field Values

mInputParams

protected java.util.List mInputParams
A list of the activity's input parameters (ActivityInputParameter)


mOutputParams

protected java.util.List mOutputParams
A list of the activity's output parameters (ActivityOuyputParameter)


query

protected java.lang.String query
The query object associated with this search.


min

protected int min
The minimum number of results from this activity.


max

protected int max
The maximum number of results from this activity.


index

protected java.lang.String index
The index associated with this search.

Constructor Detail

SearchToolkit

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

Method Detail

getInstance

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


generateXML

protected java.lang.String generateXML()
Specified by:
generateXML in class uk.org.ogsadai.client.toolkit.activity.Activity

setMin

public void setMin(int min)
Set the Minimum result requirement.


setMax

public void setMax(int max)
Set the Maximum result limit.


setQuery

public void setQuery(java.lang.String query)
Set the query, string.


setIndex

public void setIndex(java.lang.String index)
Set the index of this search, if there is one (might be NULL)


getDataOutput

public uk.org.ogsadai.client.toolkit.activity.ActivityOutput getDataOutput()
Gets the activity's data output.

Returns:
the activity output.

getSearchStatus

public uk.org.ogsadai.client.toolkit.activity.ActivityOutput getSearchStatus()
Gets the activity's search status output.

Returns:
the search status.