|
|||||||||
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.search.SearchRequest atg.search.routing.command.search.CategorizeRequest
public class CategorizeRequest
The Categorize request contains text content to categorize using the same categorization algorithm as indexed content and queries. The content can be in several forms:
setInput(java.lang.String)
Optional: Everything else
Nested Class Summary | |
---|---|
static class |
CategorizeRequest.CategorizeInputMode
The mode value can be one of four values. |
static class |
CategorizeRequest.Response
Response type for CategorizeRequest |
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.search.routing.command.search.SearchRequest |
---|
BROWSE, CACHEABLE, CATEGORIZE, DEBUG, EMPTY_ARRAY, ENV, ID, INSPECT, LIST_PROPERTY_ALLOWED, LISTABLE_PROPERTIES, LOCAL_MERGE, LOCAL_MERGE_DEBUG, LOG_THIS_REQUEST, mDebug, mListableProperties, mListPropertyAllowed, mLocalMergeDebugEnabled, mLocalMergeDebugReady, mLocalMergeEnabled, mMergeSettings, mMultiPartitionSearch, mRequestIdentifier, MsInNs, mSleepTimeMs, mTargets, mTimeLimitMs, MULTI_PARTITION, MULTI_SEARCH_SESSION, mVersion, QUERY, RESP_FORM, SAVE_REQUEST, SIMILARDOCS, SITE_CONSTR, SITE_ID, SLEEP_TIME_MS, STRUCTQUERY, TAGS, TIME, TIME_LIMIT_MS, TREEQUERY, TYPEAHEAD, VERSION, VIC |
Constructor Summary | |
---|---|
CategorizeRequest()
|
Method Summary | |
---|---|
protected SearchResponse |
doMerge(java.util.List<SearchResponse> pParsedResponses)
merges the responses |
protected static CategorizeRequest |
fromXml(atg.search.routing.utils.SearchMessageParser xml,
SearchRequest compRequest)
Constructs a new request given an initialized parser |
protected void |
getAttributeXML(java.lang.StringBuilder buf)
|
protected void |
getBodyXML(java.lang.StringBuilder buf)
|
DocumentSetConstraint |
getDocumentSetConstraints()
|
java.lang.String |
getInput()
|
CategorizeRequest.CategorizeInputMode |
getInputMode()
Returns the input mode |
ParserOptions |
getParserOptions()
|
java.lang.Boolean |
getPrune()
Returns whether categorization pruning is performed |
DocumentSetConstraint |
getRefineConstraints()
|
int |
getRequestId()
This identifies the type of request, one of SearchRequest.QUERY , SearchRequest.BROWSE , etc. |
protected SearchResponse |
processSearchResponse(atg.search.routing.command.SearchEngineResponse response)
Constructs a new response from the engine's response |
void |
setDocumentSetConstraints(DocumentSetConstraint documentSetConstraints)
|
void |
setInput(java.lang.String input)
|
void |
setInputMode(CategorizeRequest.CategorizeInputMode inputMode)
Sets the input mode. |
void |
setParserOptions(ParserOptions parserOptions)
|
void |
setPrune(java.lang.Boolean prune)
Sets whether categorization pruning is performed |
void |
setRefineConstraints(DocumentSetConstraint pRefineConstraints)
|
static CategorizeRequest |
valueOf(java.lang.String pRequestXml)
Constructs a new request from an xml string |
static CategorizeRequest |
valueOf(java.lang.String pRequestXml,
SearchRequest compRequest)
Converts an xml string into a CategorizeRequest |
Methods inherited from class atg.search.routing.command.SearchEngineRequestImpl |
---|
encodeMapData, isFiringSearchEvents, isKeepingResponseData, isLoggingThisRequest, setFiringSearchEvents, setKeepingResponseData, setLoggingThisRequest |
Methods inherited from class atg.search.routing.command.SearchXMLObject |
---|
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML |
Methods inherited from class java.lang.Object |
---|
clone, equals, 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 CategorizeRequest()
Method Detail |
---|
public java.lang.String getInput()
public void setInput(java.lang.String input)
input
- Input to categorization, depending on the mode. A question mode means the
input is a simple query text. A document mode means the input is a file pathname. A xhtml
mode means the input is a XHTML structured document text. And a text mode means that the input is simple text.public ParserOptions getParserOptions()
public void setParserOptions(ParserOptions parserOptions)
parserOptions
- text processing optionspublic DocumentSetConstraint getDocumentSetConstraints()
public void setDocumentSetConstraints(DocumentSetConstraint documentSetConstraints)
documentSetConstraints
- document set constraintspublic DocumentSetConstraint getRefineConstraints()
public void setRefineConstraints(DocumentSetConstraint pRefineConstraints)
pRefineConstraints
- document set constraintspublic CategorizeRequest.CategorizeInputMode getInputMode()
public void setInputMode(CategorizeRequest.CategorizeInputMode inputMode)
inputMode
- the modepublic java.lang.Boolean getPrune()
public void setPrune(java.lang.Boolean prune)
prune
- Whether categorization pruning is performedprotected 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 buf) throws atg.search.routing.command.IncompleteCommandException
getBodyXML
in class atg.search.routing.command.SearchXMLObject
atg.search.routing.command.IncompleteCommandException
public int getRequestId()
SearchRequest
SearchRequest.QUERY
, SearchRequest.BROWSE
, etc.
getRequestId
in class SearchRequest
protected SearchResponse processSearchResponse(atg.search.routing.command.SearchEngineResponse response) throws atg.search.routing.command.RoutingCommandException
processSearchResponse
in class SearchRequest
response
- engine response
atg.search.routing.command.RoutingCommandException
SearchRequest.processResponse(atg.search.routing.command.SearchEngineResponse)
protected SearchResponse doMerge(java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
doMerge
in class SearchRequest
pParsedResponses
-
atg.search.routing.MergeException
public static CategorizeRequest valueOf(java.lang.String pRequestXml)
pRequestXml
- categorization request xml
CategorizeRequest
instancepublic static CategorizeRequest valueOf(java.lang.String pRequestXml, SearchRequest compRequest)
pRequestXml
- categorize xmlcompRequest
- an existing (categorize) request object to combine with the provide xml, typically
initalized as a nucleus component
protected static CategorizeRequest fromXml(atg.search.routing.utils.SearchMessageParser xml, SearchRequest compRequest)
xml
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |