atg.search.routing.command.search

Class QueryTerms

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.QueryTerms

All Implemented Interfaces:

java.io.Serializable

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

A collection of QueryTerms and various stats.

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
int	getBaseWeight() Returns the Base term weight
protected void	getBodyXML(java.lang.StringBuilder sb)
int	getIndexSize() Returns the total index term frequency
QueryTermsMode	getMode() returns query terms mode
java.lang.String	getRequestTag() Gets the xml element tag used in the request
java.util.List<QueryTerm>	getTerms() Returns the List of QueryTerms
int	getTotalDocs() Returns the total documents in index
int	getTotalTerms() Returns the total index terms
int	hashCode()
void	setBaseWeight(int baseWeight) Sets the Base term weight
void	setIndexSize(int indexSize) Sets the total index term frequency
void	setMode(QueryTermsMode pMode) Sets query terms mode
void	setTerms(java.util.List<QueryTerm> terms) Sets the List of QueryTerm
void	setTotalDocs(int totalDocs) Sets the total documents in index
void	setTotalTerms(int totalTerms) Sets the total index terms

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

QueryTerms

public QueryTerms()

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

getTerms

public java.util.List<QueryTerm> getTerms()

Returns the List of QueryTerms

Returns:

List of QueryTerms

setTerms

public void setTerms(java.util.List<QueryTerm> terms)

Sets the List of QueryTerm

Parameters:

terms - List of QueryTerm

getBaseWeight

public int getBaseWeight()

Returns the Base term weight

Returns:

Base term weight

setBaseWeight

public void setBaseWeight(int baseWeight)

Sets the Base term weight

Parameters:

baseWeight - Base term weight

getMode

public QueryTermsMode getMode()

returns query terms mode

Returns:

query terms mode

setMode

public void setMode(QueryTermsMode pMode)

Sets query terms mode

Parameters:

pMode - the mode

getTotalDocs

public int getTotalDocs()

Returns the total documents in index

Returns:

Total documents in index

setTotalDocs

public void setTotalDocs(int totalDocs)

Sets the total documents in index

Parameters:

totalDocs - Total documents in index

getTotalTerms

public int getTotalTerms()

Returns the total index terms

Returns:

Total index terms

setTotalTerms

public void setTotalTerms(int totalTerms)

Sets the total index terms

Parameters:

totalTerms - Total index terms

getIndexSize

public int getIndexSize()

Returns the total index term frequency

Returns:

Total index term frequency

setIndexSize

public void setIndexSize(int indexSize)

Sets the total index term frequency

Parameters:

indexSize - Total index term frequency

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

getBodyXML

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

Overrides:

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

Throws:

atg.search.routing.command.IncompleteCommandException