atg.search.routing.command.search
Class ReportDataResults

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

All Implemented Interfaces:

java.io.Serializable

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

Report data results, from ReportDataControl.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ReportDataResults()

Method Summary

boolean	equals(java.lang.Object pObject)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.lang.String	getClusterData() Cluster normalization of query, as a sorted list of top N terms with weight greater than minimum.
java.util.List<CustomReportData>	getCustomData() Returns list of CustomReportData
java.util.List<java.lang.String>	getFinderData() Terms of query were found by patterns in the language dictionary, such as alpha-numerics
java.lang.String	getInput() Input query text
int	getLengthData() Length of query, in non-stopword count
java.util.List<java.lang.String>	getNullData() Returns the List of terms from query that do not appear in the content (nor do their term expansions, if any)
java.util.List<java.lang.String>	getNulxData() Terms from query that do not appear in the content (but have term expansions that do)
java.util.List<java.lang.String>	getNumberData() Number terms from query
java.lang.String	getRequestTag()
java.util.List<Topic>	getSelectedTopicData() Returns the List of selected topics, only available if topic was enabled
java.util.List<java.lang.String>	getTermData() Term of query, excluding punct.
java.util.List<Topic>	getTopicData() Topic classification of query
java.util.List<java.lang.String>	getTypeData() Query type of query
java.util.List<java.lang.String>	getUnknownData() Unknown term from query
void	setClusterData(java.lang.String pClusterData) Sets the cluster data
void	setCustomData(java.util.List<CustomReportData> customData) Sets the List of CustomReportData
void	setFinderData(java.util.List<java.lang.String> finderData) Sets the List of terms of query were found by patterns in the language dictionary, such as alpha-numerics
void	setInput(java.lang.String pInput) Sets input query text
void	setLengthData(int pLengthData) Sets the length data
void	setNullData(java.util.List<java.lang.String> nullData) Sets the list of null data
void	setNulxData(java.util.List<java.lang.String> nulxData) Sets the List of terms from query that do not appear in the content (but have term expansions that do)
void	setNumberData(java.util.List<java.lang.String> pNumberData) Number term from query
void	setSelectedTopicData(java.util.List<Topic> pSelectedTopicData) Sets the list of selected dopics
void	setTermData(java.util.List<java.lang.String> pTermData) Sets the term data list
void	setTopicData(java.util.List<Topic> pTopicData) Topic classification of query
void	setTypeData(java.util.List<java.lang.String> pTypeData) Query type of query
void	setUnknownData(java.util.List<java.lang.String> pUnknownData) Unknown term from query

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

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, 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

ReportDataResults

public ReportDataResults()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getClusterData

public java.lang.String getClusterData()

Cluster normalization of query, as a sorted list of top N terms with weight greater than minimum.

Returns:

Cluster normalization of query, as a sorted list of top N terms with weight greater than minimum.

setClusterData

public void setClusterData(java.lang.String pClusterData)

Sets the cluster data

Parameters:

pClusterData - Cluster normalization of query, as a sorted list of top N terms with weight greater than minimum.

getInput

public java.lang.String getInput()

Input query text

Returns:

Input query text

setInput

public void setInput(java.lang.String pInput)

Sets input query text

Parameters:

pInput - Input query text

getLengthData

public int getLengthData()

Length of query, in non-stopword count

Returns:

Length of query, in non-stopword count

setLengthData

public void setLengthData(int pLengthData)

Sets the length data

Parameters:

pLengthData - Length of query, in non-stopword count

getNumberData

public java.util.List<java.lang.String> getNumberData()

Number terms from query

Returns:

List of String. Number terms from query

setNumberData

public void setNumberData(java.util.List<java.lang.String> pNumberData)

Number term from query

Parameters:

pNumberData - List of String. Number term from query

getTermData

public java.util.List<java.lang.String> getTermData()

Term of query, excluding punct. Known forms are stemmed. List of String

Returns:

Term of query, excluding punct. Known forms are stemmed. List of String.

setTermData

public void setTermData(java.util.List<java.lang.String> pTermData)

Sets the term data list

Parameters:

pTermData - Term of query, excluding punct. Known forms are stemmed. List of Strings

getTopicData

public java.util.List<Topic> getTopicData()

Topic classification of query

Returns:

Topic classification of query. List of Topic

setTopicData

public void setTopicData(java.util.List<Topic> pTopicData)

Topic classification of query

Parameters:

pTopicData - Topic classification of query. List of Topic

getTypeData

public java.util.List<java.lang.String> getTypeData()

Query type of query

Returns:

Query type of query. List of Strings

setTypeData

public void setTypeData(java.util.List<java.lang.String> pTypeData)

Query type of query

Parameters:

pTypeData - Query type of query

getUnknownData

public java.util.List<java.lang.String> getUnknownData()

Unknown term from query

Returns:

Unknown term from query. List of Strings

setUnknownData

public void setUnknownData(java.util.List<java.lang.String> pUnknownData)

Unknown term from query

Parameters:

pUnknownData - Unknown term from query. List of Strings

getCustomData

public java.util.List<CustomReportData> getCustomData()

Returns list of CustomReportData

Returns:

List of CustomReportData

setCustomData

public void setCustomData(java.util.List<CustomReportData> customData)

Sets the List of CustomReportData

Parameters:

customData - List of CustomReportData

getFinderData

public java.util.List<java.lang.String> getFinderData()

Terms of query were found by patterns in the language dictionary, such as alpha-numerics

Returns:

List of String, terms of query were found by patterns in the language dictionary, such as alpha-numerics

setFinderData

public void setFinderData(java.util.List<java.lang.String> finderData)

Sets the List of terms of query were found by patterns in the language dictionary, such as alpha-numerics

Parameters:

finderData - List of String, terms of query were found by patterns in the language dictionary, such as alpha-numerics

getNullData

public java.util.List<java.lang.String> getNullData()

Returns the List of terms from query that do not appear in the content (nor do their term expansions, if any)

Returns:

List of String, terms from query that do not appear in the content (nor do their term expansions, if any)

setNullData

public void setNullData(java.util.List<java.lang.String> nullData)

Sets the list of null data

Parameters:

nullData - List of String

getNulxData

public java.util.List<java.lang.String> getNulxData()

Terms from query that do not appear in the content (but have term expansions that do)

Returns:

List of String, terms from query that do not appear in the content (but have term expansions that do)

setNulxData

public void setNulxData(java.util.List<java.lang.String> nulxData)

Sets the List of terms from query that do not appear in the content (but have term expansions that do)

Parameters:

nulxData - List of String, terms from query that do not appear in the content (but have term expansions that do)

getSelectedTopicData

public java.util.List<Topic> getSelectedTopicData()

Returns the List of selected topics, only available if topic was enabled

Returns:

List of Topic, selected topics, only available if topic was enabled

setSelectedTopicData

public void setSelectedTopicData(java.util.List<Topic> pSelectedTopicData)

Sets the list of selected dopics

Parameters:

pSelectedTopicData - List of Topic, selected topics

getRequestTag

public java.lang.String getRequestTag()

Specified by:

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

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