atg.search.routing.command.search
Class CategoryDocument

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.search.Document
          atg.search.routing.command.search.CategoryDocument

All Implemented Interfaces:

java.io.Serializable

public class CategoryDocument
extends Document

A category document is a Document with a few extra properties unique to the browse response.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

CategoryDocument()

Method Summary

atg.search.routing.command.search.InternalAnswerGroup	createNewAnswerGroup() Returns a new DocumentAnswerGroup
boolean	equals(java.lang.Object pObject)
int	getAnswerGroup() Returns the document's answer group
protected void	getAttributeXML(java.lang.StringBuilder sb)
java.lang.String	getContentId() Returns the content id of the partition that this result came from
Document	getDocument() Returns the associated document
int	getOriginalAnswerGroup() Returns the original answer group identifier, from before the merge.
java.lang.String	getRankCalc() Returns the rank calculation
float	getScore() Returns the score based on ranking configuration calculation
java.lang.String	getSortProp() returns the value of the grouping property
void	setAnswerGroup(int answerGroup) Sets the answer group
void	setContentId(java.lang.String pContentId) Sets the content id of the partition that this result came from
void	setId(int pId) Not used for category docs
void	setRankCalc(java.lang.String rankCalc) Sets the rank calculation
void	setScore(float score) Sets the score
void	setSortProp(java.lang.String sortProp) Sets the sort property

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

getAddress, getBodyXML, getContentId, getContextInfo, getDocset, getEscapedUrl, getFileName, getGoto, getGotoLink, getHdoc, getLanguage, getPaAnswerText, getPaQuestionText, getProperties, getRelatedDocsets, getRequestTag, getSizeBytes, getSummary, getTimestamp, getTitle, getType, getUrl, isListPropertiesAllowed, setAddress, setContentId, setContextInfo, setDocset, setFileName, setGoto, setHdoc, setLanguage, setListPropertiesAllowed, setPaAnswerText, setPaQuestionText, setProperties, setRelatedDocsets, setSizeBytes, setSummary, setTimestamp, setTitle, setType, setUrl

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

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, setParentXMLObject, 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

CategoryDocument

public CategoryDocument()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class Document

getAnswerGroup

public int getAnswerGroup()

Returns the document's answer group

Returns:

Group id of document

setAnswerGroup

public void setAnswerGroup(int answerGroup)

Sets the answer group

Parameters:

answerGroup -

getOriginalAnswerGroup

public int getOriginalAnswerGroup()

Returns the original answer group identifier, from before the merge. This is only used for merge.

Returns:

original answer group identifier

getDocument

public Document getDocument()

Returns the associated document

Returns:

the associated document

setId

public void setId(int pId)

Not used for category docs

Parameters:

pId -

createNewAnswerGroup

public atg.search.routing.command.search.InternalAnswerGroup createNewAnswerGroup()

Returns a new DocumentAnswerGroup

Returns:

new answer group

getSortProp

public java.lang.String getSortProp()

returns the value of the grouping property

Returns:

The value of the grouping property

setSortProp

public void setSortProp(java.lang.String sortProp)

Sets the sort property

Parameters:

sortProp - the sort property

getRankCalc

public java.lang.String getRankCalc()

Returns the rank calculation

Returns:

rank calculation

setRankCalc

public void setRankCalc(java.lang.String rankCalc)

Sets the rank calculation

Parameters:

rankCalc - rank calculation

getScore

public float getScore()

Returns the score based on ranking configuration calculation

Returns:

Score based on ranking configuration calculation

setScore

public void setScore(float score)

Sets the score

Parameters:

score -

getAttributeXML

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

Overrides:

getAttributeXML in class Document

Throws:

atg.search.routing.command.IncompleteCommandException

getContentId

public java.lang.String getContentId()

Returns the content id of the partition that this result came from

Returns:

the content id of the partition that this result came from

setContentId

public void setContentId(java.lang.String pContentId)

Sets the content id of the partition that this result came from

Parameters:

pContentId - the content id of the partition that this result came from