|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.search.routing.command.SearchXMLObject atg.search.routing.command.SearchEngineRequestImpl atg.search.routing.command.SearchRequestFragment atg.search.routing.command.search.StructuredStatement
public class StructuredStatement
Structured statement used in creating structured request
Nested Class Summary | |
---|---|
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 | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Constructor Summary | |
---|---|
StructuredStatement()
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object pObj)
|
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] |
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, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface atg.search.routing.command.SearchEngineRequest |
---|
toXML |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public StructuredStatement()
Method Detail |
---|
public boolean isNull()
public boolean equals(java.lang.Object pObj)
equals
in class java.lang.Object
public java.lang.String getName()
public java.lang.String getQueryText()
public StructuredStatement.Operator getOp()
public StructuredStatement.Mode getMode()
public StructuredStatement.Strategy getStrategy()
public java.lang.Integer getWeight()
public java.lang.Integer getThreshold()
public java.lang.Boolean getMutex()
public void setName(java.lang.String name)
name
- of the text fieldpublic void setQueryText(java.lang.String queryText)
queryText
- text search input for the named text fieldpublic void setOp(StructuredStatement.Operator op)
op
- mode of aggregating resultspublic void setMode(StructuredStatement.Mode mode)
mode
- query modepublic void setStrategy(StructuredStatement.Strategy strategy)
strategy
- query strategypublic void setWeight(java.lang.Integer weight)
weight
- weight of query results[0-100]public void setThreshold(java.lang.Integer threshold)
threshold
- minimum score for results [0-100]public void setMutex(java.lang.Boolean mutex)
mutex
- should this statements results be mutually exclusive of other statement resultsprotected void getAttributeXML(java.lang.StringBuilder buf) throws atg.search.routing.command.IncompleteCommandException
getAttributeXML
in class atg.search.routing.command.SearchXMLObject
atg.search.routing.command.IncompleteCommandException
protected void getBodyXML(java.lang.StringBuilder sb) throws atg.search.routing.command.IncompleteCommandException
getBodyXML
in class atg.search.routing.command.SearchXMLObject
atg.search.routing.command.IncompleteCommandException
public java.lang.String getRequestTag()
getRequestTag
in interface atg.search.routing.command.SearchEngineRequest
getRequestTag
in class atg.search.routing.command.SearchXMLObject
protected static StructuredStatement fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |