|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.search.routing.command.SearchXMLObject atg.search.routing.command.search.Document atg.search.routing.command.search.CategoryDocument
public class CategoryDocument
A category document is a Document
with a few extra properties unique
to the browse response.
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)
|
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 |
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, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, 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 |
Methods inherited from interface atg.search.routing.command.search.Groupable |
---|
getContentId, setContentId |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public CategoryDocument()
Method Detail |
---|
public boolean equals(java.lang.Object pObject)
equals
in class Document
public int getAnswerGroup()
getAnswerGroup
in interface Groupable
public void setAnswerGroup(int answerGroup)
setAnswerGroup
in interface Groupable
answerGroup
- public int getOriginalAnswerGroup()
getOriginalAnswerGroup
in interface Groupable
public Document getDocument()
getDocument
in interface Groupable
public void setId(int pId)
setId
in interface Groupable
pId
- public atg.search.routing.command.search.InternalAnswerGroup createNewAnswerGroup()
DocumentAnswerGroup
createNewAnswerGroup
in interface Groupable
public java.lang.String getSortProp()
getSortProp
in interface Groupable
public void setSortProp(java.lang.String sortProp)
sortProp
- the sort propertypublic java.lang.String getRankCalc()
public void setRankCalc(java.lang.String rankCalc)
rankCalc
- rank calculationpublic float getScore()
getScore
in interface Groupable
public void setScore(float score)
setScore
in interface Groupable
score
- protected void getAttributeXML(java.lang.StringBuilder sb) throws atg.search.routing.command.IncompleteCommandException
getAttributeXML
in class Document
atg.search.routing.command.IncompleteCommandException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |