atg.search.routing.command.search
Class Group

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

All Implemented Interfaces:

java.io.Serializable

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

A result group containing the item (may be more than one group) for diagnostic trace grouping

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Group()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static Group	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getAttributeXML(java.lang.StringBuilder sb) Override to provide attributes.
protected void	getBodyXML(java.lang.StringBuilder sb) Override to provide the body of the xml.
int	getId() Returns the the id of the group, also its original position before sorting
int	getIndex() Returns the statement index within the document that is in this group
int	getPage() Returns the page number of group after sorting
java.lang.String	getRequestTag() Gets the xml element tag used in the request
float	getScore() Returns the group score
int	getSize() Returns the original size of the group, before perGroup settings
int	getSort() Returns the end position of group after sorting
DiagnosticStatus	getStatus() Returns the status
java.lang.String	getValue() Returns the grouping value
void	setId(int pId) Sets the id of the group, also its original position before sorting
void	setIndex(int pIndex) Sets the statement index within the document that is in this group
void	setPage(int pPage) Sets the page number of group after sorting
void	setScore(float pScore) Sets the group score
void	setSize(int pSize) Sets the original size of the group, before perGroup settings
void	setSort(int pSort) Sets the end position of group after sorting
void	setStatus(DiagnosticStatus pStatus) Sets the status
void	setValue(java.lang.String pValue) Sets the grouping value

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Group

public Group()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getStatus

public DiagnosticStatus getStatus()

Returns the status

Returns:

status

setStatus

public void setStatus(DiagnosticStatus pStatus)

Sets the status

Parameters:

pStatus -

getIndex

public int getIndex()

Returns the statement index within the document that is in this group

Returns:

Statement index within the document that is in this group

setIndex

public void setIndex(int pIndex)

Sets the statement index within the document that is in this group

Parameters:

pIndex -

getId

public int getId()

Returns the the id of the group, also its original position before sorting

Returns:

The id of the group, also its original position before sorting

setId

public void setId(int pId)

Sets the id of the group, also its original position before sorting

Parameters:

pId -

getSize

public int getSize()

Returns the original size of the group, before perGroup settings

Returns:

The original size of the group, before perGroup settings

setSize

public void setSize(int pSize)

Sets the original size of the group, before perGroup settings

Parameters:

pSize -

getSort

public int getSort()

Returns the end position of group after sorting

Returns:

End position of group after sorting

setSort

public void setSort(int pSort)

Sets the end position of group after sorting

Parameters:

pSort -

getScore

public float getScore()

Returns the group score

Returns:

the group score

setScore

public void setScore(float pScore)

Sets the group score

Parameters:

pScore -

getPage

public int getPage()

Returns the page number of group after sorting

Returns:

Page number of group after sorting

setPage

public void setPage(int pPage)

Sets the page number of group after sorting

Parameters:

pPage -

getValue

public java.lang.String getValue()

Returns the grouping value

Returns:

Grouping value

setValue

public void setValue(java.lang.String pValue)

Sets the grouping value

Parameters:

pValue -

fromXmlParser

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

Override to provide attributes.

Overrides:

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

Parameters:

sb - shared buffer

Throws:

atg.search.routing.command.IncompleteCommandException - if required values are missing

getBodyXML

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

Override to provide the body of the xml. Do not include the main element tag.

Overrides:

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

Parameters:

sb - shared buffer

Throws:

atg.search.routing.command.IncompleteCommandException