atg.search.routing.command.search
Class Summary

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.search.Summary

All Implemented Interfaces:

java.io.Serializable

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

Diagnostic search summary

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Summary()

Method Summary

boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
int	getConstraintCount() Returns how many items were searchable (satisified the constraints)
int	getItemCount() Indicates how many items were retrieved by the terms
int	getRelevantCount() Indicates how many items were relevant (exceeded the min threshold)
java.lang.String	getRequestTag() Gets the xml element tag used in the request
int	getResultCount() Indicates how many items collected and appeared in the final results
int	getRetrievalCount() Indicates how many items were retrievable by the query terms
int	getStatementCount() Indicates how many items had statements retrieved by the terms
int	getTotalCount() Indicates how many items were in the index
void	setConstraintCount(int pConstraintCount) Sets how many items were searchable (satisified the constraints)
void	setItemCount(int pItemCount) Sets how many items were retrieved by the terms
void	setRelevantCount(int pRelevantCount) Sets how many items were relevant (exceeded the min threshold)
void	setResultCount(int pResultCount) Sets how many items collected and appeared in the final results
void	setRetrievalCount(int pRetrievalCount) Sets how many items were retrievable by the query terms
void	setStatementCount(int pStatementCount) Sets how many items had statements retrieved by the terms
void	setTotalCount(int pTotalCount) Sets how many items were in the index?

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

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getBodyXML, 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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Summary

public Summary()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getTotalCount

public int getTotalCount()

Indicates how many items were in the index

Returns:

How many items were in the index

setTotalCount

public void setTotalCount(int pTotalCount)

Sets how many items were in the index?

Parameters:

pTotalCount - how many items were in the index?

getRetrievalCount

public int getRetrievalCount()

Indicates how many items were retrievable by the query terms

Returns:

How many items were retrievable by the query terms

setRetrievalCount

public void setRetrievalCount(int pRetrievalCount)

Sets how many items were retrievable by the query terms

Parameters:

pRetrievalCount - how many items were retrievable by the query terms

getConstraintCount

public int getConstraintCount()

Returns how many items were searchable (satisified the constraints)

Returns:

How many items were searchable (satisified the constraints)

setConstraintCount

public void setConstraintCount(int pConstraintCount)

Sets how many items were searchable (satisified the constraints)

Parameters:

pConstraintCount - how many items were searchable (satisified the constraints)

getItemCount

public int getItemCount()

Indicates how many items were retrieved by the terms

Returns:

How many items were retrieved by the terms

setItemCount

public void setItemCount(int pItemCount)

Sets how many items were retrieved by the terms

Parameters:

pItemCount - how many items were retrieved by the terms

getStatementCount

public int getStatementCount()

Indicates how many items had statements retrieved by the terms

Returns:

How many items had statements retrieved by the terms

setStatementCount

public void setStatementCount(int pStatementCount)

Sets how many items had statements retrieved by the terms

Parameters:

pStatementCount - how many items had statements retrieved by the terms

getRelevantCount

public int getRelevantCount()

Indicates how many items were relevant (exceeded the min threshold)

Returns:

How many items were relevant (exceeded the min threshold)

setRelevantCount

public void setRelevantCount(int pRelevantCount)

Sets how many items were relevant (exceeded the min threshold)

Parameters:

pRelevantCount - how many items were relevant (exceeded the min threshold)

getResultCount

public int getResultCount()

Indicates how many items collected and appeared in the final results

Returns:

How many items collected and appeared in the final results

setResultCount

public void setResultCount(int pResultCount)

Sets how many items collected and appeared in the final results

Parameters:

pResultCount - how many items collected and appeared in the final results

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

getAttributeXML

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

Overrides:

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

Throws:

atg.search.routing.command.IncompleteCommandException