atg.search.routing.command.search
Class ExpansionEntry

java.lang.Object
  extended by atg.search.routing.command.SearchXMLObject
      extended by atg.search.routing.command.search.ExpansionEntry
All Implemented Interfaces:
java.io.Serializable

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

A term expansion entry. User: jrowe Date: Aug 21, 2006 Time: 9:01:49 AM

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
ExpansionEntry()
           
 
Method Summary
 boolean equals(java.lang.Object pObject)
           
protected  void getAttributeXML(java.lang.StringBuilder sb)
           
protected  void getBodyXML(java.lang.StringBuilder sb)
           
 int getDocfreq()
          Returns the doc frequency
 java.util.List<SourceTerm> getFromSourceTerms()
          Returns the List of SourceTerms of the expansion
 atg.search.routing.utils.Language getLang()
          Returns the Language of the expansion, if different from the query language, otherwise null
 java.lang.String getRequestTag()
          Gets the xml element tag used in the request
 int getSentfreq()
          Returns the sentence frequency
 java.lang.String getToExpansion()
          Returns the term expansion
 int getWeight()
          Returns the term weight of expansion
 void setDocfreq(int docfreq)
          Sets the doc frequency
 void setFromSourceTerms(java.util.List<SourceTerm> fromSourceTerms)
          Sets the List of SourceTerms of the expansion
 void setLang(atg.search.routing.utils.Language lang)
          Sets the Language of the expansion
 void setSentfreq(int sentfreq)
          Sets the sentence frequency
 void setToExpansion(java.lang.String toExpansion)
          Sets the term expansion
 void setWeight(int weight)
          Sets the Term weight of expansion
 
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

ExpansionEntry

public ExpansionEntry()
Method Detail

equals

public boolean equals(java.lang.Object pObject)
Overrides:
equals in class java.lang.Object

getWeight

public int getWeight()
Returns the term weight of expansion

Returns:
Term weight of expansion

setWeight

public void setWeight(int weight)
Sets the Term weight of expansion

Parameters:
weight - Term weight of expansion

getLang

public atg.search.routing.utils.Language getLang()
Returns the Language of the expansion, if different from the query language, otherwise null

Returns:
Language of the expansion, if different from the query language, otherwise null

setLang

public void setLang(atg.search.routing.utils.Language lang)
Sets the Language of the expansion

Parameters:
lang - Language of the expansion

getToExpansion

public java.lang.String getToExpansion()
Returns the term expansion

Returns:
Term expansion

setToExpansion

public void setToExpansion(java.lang.String toExpansion)
Sets the term expansion

Parameters:
toExpansion - Term expansion

getFromSourceTerms

public java.util.List<SourceTerm> getFromSourceTerms()
Returns the List of SourceTerms of the expansion

Returns:
List of SourceTerms of the expansion

setFromSourceTerms

public void setFromSourceTerms(java.util.List<SourceTerm> fromSourceTerms)
Sets the List of SourceTerms of the expansion

Parameters:
fromSourceTerms - List of SourceTerms of the expansion

getDocfreq

public int getDocfreq()
Returns the doc frequency

Returns:
doc frequency

setDocfreq

public void setDocfreq(int docfreq)
Sets the doc frequency

Parameters:
docfreq -

getSentfreq

public int getSentfreq()
Returns the sentence frequency

Returns:
sentence frequency

setSentfreq

public void setSentfreq(int sentfreq)
Sets the sentence frequency

Parameters:
sentfreq -

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