com.primus.ae.searchclient
Class ClientSimilarDocsRequest

java.lang.Object
  com.primus.ae.searchclient.ClientRequestImpl
      com.primus.ae.searchclient.ClientSimilarDocsRequest

All Implemented Interfaces:

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

Deprecated. as of 9.0. Use SimilarDocsRequest instead.

public class ClientSimilarDocsRequest
extends ClientRequestImpl

Client similar docs request

See Also:

Serialized Form

Field Summary

Fields inherited from class com.primus.ae.searchclient.ClientRequestImpl

constraints, listPropertyAllowed, loggingEnabled, mLoggingThisRequest, mRequestIdentifier, mRequestTime, parsingOptions, requestAttributes

Fields inherited from interface com.primus.ae.searchclient.ClientRequest

BROWSE, CATEGORIZE, INSPECT, QUERY, REQUEST_TAG_BROWSE, REQUEST_TAG_CATEGORIZE, REQUEST_TAG_QUERY, REQUEST_TAG_SIMILARDOCS, REQUEST_TAG_STRUCTQUERY, REQUEST_TAG_VIC, SIMILARDOCS, STRUCTQUERY, TAGS, VIC

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

CLASS_VERSION

Constructor Summary

ClientSimilarDocsRequest()
Deprecated.

ClientSimilarDocsRequest(java.lang.String input)
Deprecated. simplest possible similar docs request

ClientSimilarDocsRequest(java.lang.String input, java.util.Map requestAttributes, DocumentSetConstraint constraints, ParserOptions parserOptions)
Deprecated.

ClientSimilarDocsRequest(java.lang.String input, java.util.Map requestAttributes, DocumentSetConstraint constraints, ParserOptions parserOptions, boolean enableLogging)
Deprecated. as of 2007.0

Method Summary

java.lang.String	getInput() Deprecated.
int	getRequestId() Deprecated.
void	setInput(java.lang.String input) Deprecated.
java.lang.String	toXML() Deprecated. returns xml suitable for submission to a search engine.

Methods inherited from class com.primus.ae.searchclient.ClientRequestImpl

getConstraints, getConstraintsXml, getParsingOptions, getParsingOptionsXml, getRequestAttribute, getRequestAttributes, getRequestIdentifier, getRequestTag, getRequestTime, getSearchConstraints, isFiringSearchEvents, isKeepingResponseData, isListPropertyAllowed, isLoggingEnabled, isLoggingThisRequest, processResponse, setConstraints, setFiringSearchEvents, setKeepingResponseData, setListPropertyAllowed, setLoggingEnabled, setLoggingThisRequest, setParsingOptions, setRequestAttribute, setRequestAttributes, setRequestIdentifier, setRequestTime

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientSimilarDocsRequest

public ClientSimilarDocsRequest()

Deprecated.

ClientSimilarDocsRequest

public ClientSimilarDocsRequest(java.lang.String input,
                                java.util.Map requestAttributes,
                                DocumentSetConstraint constraints,
                                ParserOptions parserOptions)

Deprecated.

Parameters:

input - Input to use for similarity comparison. The value depends on the mode attribute: hdoc mode means input is a document identifier; url mode means the input is a URL; text mode means the input is a text string; and xhtml mode means the input is an XHTML structured document

requestAttributes - Map of request attributes.

constraints - Document set constraint.

parserOptions - parser options xml. See supporting documentation

See Also:

SimilarTextConstants

ClientSimilarDocsRequest

public ClientSimilarDocsRequest(java.lang.String input,
                                java.util.Map requestAttributes,
                                DocumentSetConstraint constraints,
                                ParserOptions parserOptions,
                                boolean enableLogging)

Deprecated. as of 2007.0

Parameters:

input - Input to use for similarity comparison. The value depends on the mode attribute: hdoc mode means input is a document identifier; url mode means the input is a URL; text mode means the input is a text string; and xhtml mode means the input is an XHTML structured document

requestAttributes - Map of request attributes.

constraints - Document set constraint.

parserOptions - parser options xml. See supporting documentation

enableLogging - ignored

See Also:

SimilarTextConstants

ClientSimilarDocsRequest

public ClientSimilarDocsRequest(java.lang.String input)

Deprecated.

simplest possible similar docs request

Parameters:

input - Input to use for similarity comparison. The value depends on the mode attribute: hdoc mode means input is a document identifier; url mode means the input is a URL; text mode means the input is a text string; and xhtml mode means the input is an XHTML structured document

Method Detail

getInput

public java.lang.String getInput()

Deprecated.

Returns:

input text

setInput

public void setInput(java.lang.String input)

Deprecated.

Parameters:

input - input text

getRequestId

public int getRequestId()

Deprecated.

Returns:

ClientRequest.SIMILARDOCS

toXML

public java.lang.String toXML()
                       throws atg.search.routing.command.IncompleteCommandException

Deprecated.

returns xml suitable for submission to a search engine. In the case where this request has already been submitted, call this method to examine the submitted xml.

Returns:

request xml

Throws:

atg.search.routing.command.IncompleteCommandException - if the command is incomplete