atg.search.routing.command.search

Class Diagnostics

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.Diagnostics

All Implemented Interfaces:

java.io.Serializable

public class Diagnostics
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable

Search diagnostic tracing and inspection output

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
Diagnostics()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject)
protected static Diagnostics	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getBodyXML(java.lang.StringBuilder sb)
Inspect	getInspect() Returns the traced item inspection details
QueryAction	getQueryAction() Returns the query analysis rule actions
QueryRule	getQueryRule() Returns the query analysis rule operations
QueryTerms	getQueryTerms() Returns the advanced query term vector data
java.lang.String	getRequestTag() Gets the xml element tag used in the request
java.lang.String	getSearchInput() Returns the original text query
Summary	getSummary() Returns the diagnostic search summary
Trace	getTrace() Returns the search tracing, per item
int	hashCode()
void	setInspect(Inspect pInspect) Sets traced item inspection details
void	setQueryAction(QueryAction pQueryAction) Sets the query analysis rule actions
void	setQueryRule(QueryRule pQueryRule) Sets the query analysis rule operations
void	setQueryTerms(QueryTerms pQueryTerms) Sets the advanced query term vector data
void	setSearchInput(java.lang.String pSearchInput) Sets the original text query
void	setSummary(Summary pSummary) Sets the diagnostic search summary
void	setTrace(Trace pTrace) Sets the search tracing, per item

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Diagnostics

public Diagnostics()

Method Detail

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

getSummary

public Summary getSummary()

Returns the diagnostic search summary

Returns:

diagnostic search summary

setSummary

public void setSummary(Summary pSummary)

Sets the diagnostic search summary

Parameters:

pSummary -

getSearchInput

public java.lang.String getSearchInput()

Returns the original text query

Returns:

original text query

setSearchInput

public void setSearchInput(java.lang.String pSearchInput)

Sets the original text query

Parameters:

pSearchInput -

getQueryTerms

public QueryTerms getQueryTerms()

Returns the advanced query term vector data

Returns:

advanced query term vector data

setQueryTerms

public void setQueryTerms(QueryTerms pQueryTerms)

Sets the advanced query term vector data

Parameters:

pQueryTerms -

getQueryRule

public QueryRule getQueryRule()

Returns the query analysis rule operations

Returns:

query analysis rule operations

setQueryRule

public void setQueryRule(QueryRule pQueryRule)

Sets the query analysis rule operations

Parameters:

pQueryRule -

getQueryAction

public QueryAction getQueryAction()

Returns the query analysis rule actions

Returns:

query analysis rule actions

setQueryAction

public void setQueryAction(QueryAction pQueryAction)

Sets the query analysis rule actions

Parameters:

pQueryAction -

getInspect

public Inspect getInspect()

Returns the traced item inspection details

Returns:

traced item inspection details

setInspect

public void setInspect(Inspect pInspect)

Sets traced item inspection details

Parameters:

pInspect -

getTrace

public Trace getTrace()

Returns the search tracing, per item

Returns:

search tracing, per item

setTrace

public void setTrace(Trace pTrace)

Sets the search tracing, per item

Parameters:

pTrace -

fromXmlParser

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

getRequestTag

public java.lang.String getRequestTag()

Gets the xml element tag used in the request

Specified by:

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

Returns:

xml element tag

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