ecologylab.services.messages.cf
Class SearchState

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.services.messages.cf.Seed
              ecologylab.services.messages.cf.SearchState

All Implemented Interfaces:

OptimizationTypes, XMLTranslationExceptionTypes

public class SearchState
extends Seed

Seed element that directs combinFormation to perform a search. Starts by providing a basis for specification of search seeds. Then, keeps state during processing of the search. Version for client only:

data slot definitions only with no other functionality.

Author:

andruid

Nested Class Summary

Nested classes/interfaces inherited from class ecologylab.xml.ElementState

ElementState.ClassToCollectionMap, ElementState.DeclarationStyle, ElementState.xml_attribute, ElementState.xml_class, ElementState.xml_classes, ElementState.xml_collection, ElementState.xml_leaf, ElementState.xml_map, ElementState.xml_nested, ElementState.xml_tag

Field Summary

protected java.lang.String	creator For del.icio.us only.
protected java.lang.String	engine Search engine to use.
protected java.lang.String	query Query string to pass to the search engine.

Fields inherited from class ecologylab.services.messages.cf.Seed

bias

Fields inherited from class ecologylab.xml.ElementState

CDATA, ESTIMATE_CHARS_PER_FIELD, FLOATING_PRECISION_OFF, MARSHALLING_PARAMS, NORMAL, UTF16, UTF16_LE, UTF8, XML_FILE_HEADER

Fields inherited from interface ecologylab.xml.OptimizationTypes

BAD_FIELD, COLLECTION_ELEMENT, COLLECTION_SCALAR, IGNORED_ATTRIBUTE, IGNORED_ELEMENT, LEAF_NODE_VALUE, MAP_ELEMENT, MAP_SCALAR, NAME_SPACE_ATTRIBUTE, NAME_SPACE_LEAF_NODE, NAME_SPACE_MASK, NAME_SPACE_NESTED_ELEMENT, NAMESPACE_IGNORED_ELEMENT, NAMESPACE_TRIAL_ELEMENT, OTHER_NESTED_ELEMENT, REGULAR_ATTRIBUTE, REGULAR_NESTED_ELEMENT, ROOT, UNSET_TYPE, XMLNS_ATTRIBUTE, XMLNS_IGNORED

Fields inherited from interface ecologylab.xml.XMLTranslationExceptionTypes

FILE_NOT_FOUND, IO_EXCEPTION, NULL_PURL, UNKNOWN

Constructor Summary

SearchState()
Default constructor.

SearchState(java.lang.String engine, java.lang.String query)
Construct with engine and query.

Method Summary

java.lang.String	getCreator()
java.lang.String	getEngine()
java.lang.String	getQuery()
void	setCreator(java.lang.String creator)
void	setEngine(java.lang.String engine) Set search engine.
void	setEngineAndQuery(java.lang.String engine, java.lang.String query) Form a typical search query.
void	setQuery(java.lang.String query)

Methods inherited from class ecologylab.services.messages.cf.Seed

getBias, setBias

Methods inherited from class ecologylab.xml.ElementState

addNestedElement, addNestedElement, appendTextNodeString, buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, convertNameStyles, createChildHook, fieldToXMLOptimizations, floatingPrecision, getCollection, getElementStateById, getMap, getNestedNameSpace, getTextNodeString, leafElementFieldNames, lookupNestedNameSpace, optimizations, parent, postTranslationProcessingHook, preTranslationProcessingHook, recycle, setDeclarationStyle, setFieldUsingTypeRegistry, setFloatingPrecision, setParent, setUseDOMForTranslateTo, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXMLCharSequence, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOMCharSequence, translateFromXMLDOMCharSequence, translateFromXMLRootNode, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateToDOM, translateToXML, translateToXML, translateToXML, translateToXML, writePrettyXML, writePrettyXML, writePrettyXML

Methods inherited from class ecologylab.generic.Debug

classSimpleName, closeLoggingFile, debug, debug, debug, debug, debugA, debugA, debugA, debugI, debugI, debugI, error, error, getClassName, getClassName, getInteractive, getPackageName, getPackageName, getPackageName, initialize, level, level, level, logToFile, print, print, println, println, println, println, println, println, printlnA, printlnA, printlnA, printlnI, printlnI, printlnI, printlnI, setLoggingFile, show, show, superString, toggleInteractive, toString, toString, warning, warning, weird, weird

Methods inherited from class java.lang.Object

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

Field Detail

engine

protected java.lang.String engine

Search engine to use. Currently supported are "google", "flickr", "yahoo", "yahoo_image", "yahoo_news", "yahoo_buzz", "delicious".

query

protected java.lang.String query

Query string to pass to the search engine.

creator

protected java.lang.String creator

For del.icio.us only. Allows querying the delicious tags for a particular user.

Constructor Detail

SearchState

public SearchState()

Default constructor.

SearchState

public SearchState(java.lang.String engine,
                   java.lang.String query)

Construct with engine and query.

Parameters:

engine - Search engine to use. Currently supported are "google", "flickr", "yahoo", "yahoo_image", "yahoo_news", "yahoo_buzz", "delicious".

query - Search query to pass to the engine.

Method Detail

getCreator

public java.lang.String getCreator()

Returns:

Returns the creator.

setCreator

public void setCreator(java.lang.String creator)

Parameters:

creator - The creator to set.

getEngine

public java.lang.String getEngine()

Returns:

Returns the engine.

setEngine

public void setEngine(java.lang.String engine)

Set search engine.

Parameters:

engine - Search engine to use. Currently supported are "google", "flickr", "yahoo", "yahoo_image", "yahoo_news", "yahoo_buzz", "delicious".

getQuery

public java.lang.String getQuery()

Returns:

Returns the search query being sent to the engine.

setQuery

public void setQuery(java.lang.String query)

Parameters:

query - The search query to send to the engine.

setEngineAndQuery

public void setEngineAndQuery(java.lang.String engine,
                              java.lang.String query)

Form a typical search query.

Parameters:

engine - Search engine to use. Currently supported are "google", "flickr", "yahoo", "yahoo_image", "yahoo_news", "yahoo_buzz", "delicious".

query - Search query to pass to the engine.