atg.search.routing.command.search

Class StructuredStatement

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.SearchEngineRequestImpl

atg.search.routing.command.SearchRequestFragment

atg.search.routing.command.search.StructuredStatement

All Implemented Interfaces:

atg.search.routing.command.SearchEngineRequest, java.io.Serializable

public class StructuredStatement
extends atg.search.routing.command.SearchRequestFragment

Structured statement used in creating structured request

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructuredStatement.Mode ATG Search handles natural language and Boolean queries.
static class	StructuredStatement.Operator The Structured Query request must aggregate the results of the individual queries into a final results list, using the retrieved index items.
static class	StructuredStatement.Strategy ATG Search has a large number of search parameters that control the generic search algorithm.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
StructuredStatement()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject)
protected static StructuredStatement	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getAttributeXML(java.lang.StringBuilder buf)
protected void	getBodyXML(java.lang.StringBuilder sb)
StructuredStatement.Mode	getMode() Returns the query mode
java.lang.Boolean	getMutex() Indicates whether this statement's results be mutually exclusive of other statement results
java.lang.String	getName() Returns the name of the text field
StructuredStatement.Operator	getOp() Returns op mode of aggregating results
java.lang.String	getQueryText() Returns the text search input for the named text field
java.lang.String	getRequestTag()
StructuredStatement.Strategy	getStrategy() Returns the strategy query strategy
java.lang.Integer	getThreshold() Returns the minimum score for results [0-100]
java.lang.Integer	getWeight() Returns the weight of query results[0-100]
int	hashCode()
boolean	isNull() Indicates whether the name or query text have been set.
void	setMode(StructuredStatement.Mode mode) Sets the query mode
void	setMutex(java.lang.Boolean mutex) Controls whether should this statements results be mutually exclusive of other statement results
void	setName(java.lang.String name) Sets name of the text field
void	setOp(StructuredStatement.Operator op) Sets the mode of aggregating results
void	setQueryText(java.lang.String queryText) Setsd text search input for the named text field
void	setStrategy(StructuredStatement.Strategy strategy) Sets the strategy
void	setThreshold(java.lang.Integer threshold) Sets the threshold
void	setWeight(java.lang.Integer weight) Sets the weight of query results

Methods inherited from class atg.search.routing.command.SearchEngineRequestImpl

encodeMapData, getRequestAttribute, getRequestAttributes, isFiringSearchEvents, isKeepingResponseData, isLoggingThisRequest, processResponse, setFiringSearchEvents, setKeepingResponseData, setLoggingThisRequest, setRequestAttribute, setRequestAttributes

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface atg.search.routing.command.SearchEngineRequest

toXML

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

StructuredStatement

public StructuredStatement()

Method Detail

isNull

public boolean isNull()

Indicates whether the name or query text have been set. Returns true if both are unset.

Returns:

whether the name or query text have been set. Returns true if both are unset.

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getName

public java.lang.String getName()

Returns the name of the text field

Returns:

name name of the text field

getQueryText

public java.lang.String getQueryText()

Returns the text search input for the named text field

Returns:

queryText text search input for the named text field

getOp

public StructuredStatement.Operator getOp()

Returns op mode of aggregating results

Returns:

op mode of aggregating results

getMode

public StructuredStatement.Mode getMode()

Returns the query mode

Returns:

mode query mode

getStrategy

public StructuredStatement.Strategy getStrategy()

Returns the strategy query strategy

Returns:

strategy query strategy

getWeight

public java.lang.Integer getWeight()

Returns the weight of query results[0-100]

Returns:

weight of query results[0-100]

getThreshold

public java.lang.Integer getThreshold()

Returns the minimum score for results [0-100]

Returns:

minimum score for results [0-100]

getMutex

public java.lang.Boolean getMutex()

Indicates whether this statement's results be mutually exclusive of other statement results

Returns:

whether this statement's results be mutually exclusive of other statement results

setName

public void setName(java.lang.String name)

Sets name of the text field

Parameters:

name - of the text field

setQueryText

public void setQueryText(java.lang.String queryText)

Setsd text search input for the named text field

Parameters:

queryText - text search input for the named text field

setOp

public void setOp(StructuredStatement.Operator op)

Sets the mode of aggregating results

Parameters:

op - mode of aggregating results

setMode

public void setMode(StructuredStatement.Mode mode)

Sets the query mode

Parameters:

mode - query mode

setStrategy

public void setStrategy(StructuredStatement.Strategy strategy)

Sets the strategy

Parameters:

strategy - query strategy

setWeight

public void setWeight(java.lang.Integer weight)

Sets the weight of query results

Parameters:

weight - weight of query results[0-100]

setThreshold

public void setThreshold(java.lang.Integer threshold)

Sets the threshold

Parameters:

threshold - minimum score for results [0-100]

setMutex

public void setMutex(java.lang.Boolean mutex)

Controls whether should this statements results be mutually exclusive of other statement results

Parameters:

mutex - should this statements results be mutually exclusive of other statement results

getAttributeXML

protected void getAttributeXML(java.lang.StringBuilder buf)
                        throws atg.search.routing.command.IncompleteCommandException

Overrides:

getAttributeXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException

getBodyXML

protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException

Overrides:

getBodyXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException

getRequestTag

public java.lang.String getRequestTag()

Specified by:

getRequestTag in interface atg.search.routing.command.SearchEngineRequest

Specified by:

getRequestTag in class atg.search.routing.command.SearchXMLObject

fromXmlParser

protected static StructuredStatement fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)