atg.search.routing.command.search

Class ItemSummary

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.ItemSummary

All Implemented Interfaces:

java.io.Serializable

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

Summary status of search phases

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
ItemSummary()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject)
protected static ItemSummary	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getAttributeXML(java.lang.StringBuilder sb)
DiagnosticStatus	getConstraint() Returns an indication of whether the item satisfied the constraint
DiagnosticStatus	getIndexed() Returns an indication of whether the item was in the index
DiagnosticStatus	getItem() Returns an indication of whether the item was retrieved
DiagnosticStatus	getRelevance() Returns an indication of whether the item was relevant
java.lang.String	getRequestTag() Gets the xml element tag used in the request
DiagnosticStatus	getResult() Returns an indication of whether item ended up in the final result
DiagnosticStatus	getRetrieval() Returns an indication of whether the item was retrieved by the query terms
DiagnosticStatus	getStatement() Returns an indication of whether the item's statements got retrieved
int	hashCode()
void	setConstraint(DiagnosticStatus pConstraint) Sets whether the item satisfied the constraint
void	setIndexed(DiagnosticStatus pIndexed) sets indexed status
void	setItem(DiagnosticStatus pItem) Sets an indication of whether the item was retrieved
void	setRelevance(DiagnosticStatus pRelevance) Sets relevance status
void	setResult(DiagnosticStatus pResult) Sets the result status
void	setRetrieval(DiagnosticStatus pRetrieval) Sets the retrieval status
void	setStatement(DiagnosticStatus pStatement) Sets the statement status

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, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ItemSummary

public ItemSummary()

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

getIndexed

public DiagnosticStatus getIndexed()

Returns an indication of whether the item was in the index

Returns:

Was the item in the index?

setIndexed

public void setIndexed(DiagnosticStatus pIndexed)

sets indexed status

Parameters:

pIndexed -

getRetrieval

public DiagnosticStatus getRetrieval()

Returns an indication of whether the item was retrieved by the query terms

Returns:

Was the item retrieved by the query terms?

setRetrieval

public void setRetrieval(DiagnosticStatus pRetrieval)

Sets the retrieval status

Parameters:

pRetrieval -

getConstraint

public DiagnosticStatus getConstraint()

Returns an indication of whether the item satisfied the constraint

Returns:

Did the item satisfy the constraint?

setConstraint

public void setConstraint(DiagnosticStatus pConstraint)

Sets whether the item satisfied the constraint

Parameters:

pConstraint -

getItem

public DiagnosticStatus getItem()

Returns an indication of whether the item was retrieved

Returns:

Did the item get retrieved?

setItem

public void setItem(DiagnosticStatus pItem)

Sets an indication of whether the item was retrieved

Parameters:

pItem -

getStatement

public DiagnosticStatus getStatement()

Returns an indication of whether the item's statements got retrieved

Returns:

Did the item's statements get retrieved?

setStatement

public void setStatement(DiagnosticStatus pStatement)

Sets the statement status

Parameters:

pStatement -

getRelevance

public DiagnosticStatus getRelevance()

Returns an indication of whether the item was relevant

Returns:

Was the item relevant?

setRelevance

public void setRelevance(DiagnosticStatus pRelevance)

Sets relevance status

Parameters:

pRelevance -

getResult

public DiagnosticStatus getResult()

Returns an indication of whether item ended up in the final result

Returns:

Did the item end up in the final results?

setResult

public void setResult(DiagnosticStatus pResult)

Sets the result status

Parameters:

pResult -

fromXmlParser

protected static ItemSummary 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

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