com.primus.searchstudio
Class CategoryDocument

java.lang.Object
  com.primus.searchstudio.Response
      com.primus.searchstudio.CategoryDocument

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CategoryPrefAnswer

public class CategoryDocument
extends Response
implements java.io.Serializable

Browse CategoryDocument value object.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.primus.searchstudio.Response

answerGroup, bAnswer, bExcerptIsTruncated, contentId, contextId, DOC_TYPE_HTML, DOC_TYPE_IFILTER, DOC_TYPE_MAX, DOC_TYPE_MIN, DOC_TYPE_NONE, DOC_TYPE_PDF, DOC_TYPE_TEXT, DOC_TYPE_UNKNOWN, DOC_TYPE_XHTML, docset, docType, docTypeAsString, elapsedTime, excerpt, excerptOriginal, excerptRaw, excerptTruncated, gotoLink, instantPA, INVALID_ANSWER_SCORE, language, maxExcerptChars, nameMap, properties, queryMode, question, responseId, RESULT_TYPE_BROWSE, RESULT_TYPE_DOCUMENT, RESULT_TYPE_MAX, RESULT_TYPE_MIN, RESULT_TYPE_PREFANSWER, RESULT_TYPE_SENTENCE, RESULT_TYPE_SOLUTION, RESULT_TYPE_STRUCT, resultCount, resultType, score, SERVER_TYPE_AE, SERVER_TYPE_MAX, SERVER_TYPE_MIN, serverType, size, SOLUTION_TYPE_MAX, SOLUTION_TYPE_MIN, SOLUTION_TYPE_ROLE_CAUSE, SOLUTION_TYPE_ROLE_CHANGE, SOLUTION_TYPE_ROLE_FACT, SOLUTION_TYPE_ROLE_FIX, SOLUTION_TYPE_ROLE_GOAL, SOLUTION_TYPE_ROLE_ID, SOLUTION_TYPE_ROLE_SYMPTOM, SOLUTION_TYPE_ROLE_TITLE, solutionId, solutionType, source, SOURCE_ANSWERKB, SOURCE_ESERVER, SOURCE_MAX, SOURCE_MIN, timestamp, title, url, viewable

Constructor Summary

CategoryDocument(java.lang.String contextId, java.lang.String clusterName, java.lang.String groupid, int docType, java.lang.String url)
Constructor for creating a Document object for a view-document using a document property (e.g.

CategoryDocument(java.lang.String contextId, java.lang.String groupId, java.lang.String solutionId, int docType, java.lang.String url, java.lang.String title, long timestamp, int resultCount, java.lang.String docset, java.lang.String size, java.lang.String clusterName, java.lang.String summary, java.lang.String contentId)
Create a new Category Doocument Object.

CategoryDocument(java.lang.String contextId, java.lang.String groupId, java.lang.String solutionId, int docType, java.lang.String url, java.lang.String title, long timestamp, int resultCount, java.lang.String docset, java.lang.String size, java.lang.String clusterName, java.lang.String summary, java.lang.String contentId, java.lang.String lang, java.lang.Integer answerGroup)

Method Summary

java.util.Comparator	byDocScore()
java.util.Comparator	byTimestamp()
java.lang.String	getDebugNodeString() Gets the debug String.
java.lang.String	getDebugString() Gets the debug String.
java.lang.String	getFullTitle()
boolean	getIsTruncated()
java.lang.String	getLang()
java.lang.String	getNormalizedResponse() Gets the normalized response String.
long	getPaTimestamp() Gets the PrefAnswer modified timestamp property.
java.lang.String	getPaTimestampString() Gets the prefanswer modify timestamp as a String.
int	getPopularity()
java.lang.String	getRankCalc()
com.primus.frameworks.UniqueID	getResponseId() Gets the responseId property.
java.lang.String	getSummary()
long	getTimestamp() Gets the document modified timestamp property.
java.lang.String	getTitle() Gets the title property.
int	getVicDocType() Gets the doc type of this result for use in a View in Context command.
java.lang.String	getVicDocTypeAsString() Gets the string representation of the doc type of this result for use in a View in Context command.
int	hashCode() Standard hash code method.
void	setDebugNodeString(java.lang.String ds) Sets the debug String.
void	setIsTruncated(boolean isTruncated)
void	setLang(java.lang.String pLang)
void	setNormalizedResponse(java.lang.String norm) Sets the normalized response String.
void	setPaTimestamp(long paTimestamp)
void	setProperties(java.util.HashMap properties)
void	setRankCalc(java.lang.String rankCalc)
java.lang.String	toString() Standard toString method.
java.lang.String	toSummaryString() Standard toString method, but returns summaries of long text fields.

Methods inherited from class com.primus.searchstudio.Response

computeExcerpt, getAnswerGroup, getAnswerOffset, getClusterName, getContentId, getContextId, getDocset, getDocType, getDocTypeAsString, getDocTypeAsString, getElapsedTime, getExcerpt, getExcerptIsTruncated, getExcerptRaw, getExcerptTruncated, getGotoLink, getGroupId, getHDoc, getIsInstantPA, getLanguage, getPhysicalPartitionId, getProperties, getQueryMode, getQuestion, getResponseSummary, getResultCount, getResultType, getResultTypeAsString, getScore, getServerType, getServerTypeAsString, getSize, getSizeAsKB, getSolutionId, getSolutionIdViewedAnswer, getSolutionType, getSource, getSourceAsString, getTimestampString, getUrl, getVicQueryMap, getVicQueryMapLinkToSource, isbAnswer, isExcerptTruncated, isSolution, isViewable, setAnswerGroup, setContentId, setDocset, setElapsedTime, setExcerpt, setGotoLink, setLanguage, setMaxExcerptChars, setPhysicalPartitionId, setQueryMode, setQuestion, setResultCount, setResultType, setScore, setSolutionId, setSolutionType, setSource, setTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CategoryDocument

public CategoryDocument(java.lang.String contextId,
                        java.lang.String groupId,
                        java.lang.String solutionId,
                        int docType,
                        java.lang.String url,
                        java.lang.String title,
                        long timestamp,
                        int resultCount,
                        java.lang.String docset,
                        java.lang.String size,
                        java.lang.String clusterName,
                        java.lang.String summary,
                        java.lang.String contentId)

Create a new Category Doocument Object. Extends Response.

Parameters:

contextId -

groupId -

docType -

url -

title -

timestamp -

resultCount -

docset -

size -

clusterName -

summary -

CategoryDocument

public CategoryDocument(java.lang.String contextId,
                        java.lang.String groupId,
                        java.lang.String solutionId,
                        int docType,
                        java.lang.String url,
                        java.lang.String title,
                        long timestamp,
                        int resultCount,
                        java.lang.String docset,
                        java.lang.String size,
                        java.lang.String clusterName,
                        java.lang.String summary,
                        java.lang.String contentId,
                        java.lang.String lang,
                        java.lang.Integer answerGroup)

CategoryDocument

public CategoryDocument(java.lang.String contextId,
                        java.lang.String clusterName,
                        java.lang.String groupid,
                        int docType,
                        java.lang.String url)

Constructor for creating a Document object for a view-document using a document property (e.g. solution id)

Method Detail

setProperties

public void setProperties(java.util.HashMap properties)

Overrides:

setProperties in class Response

getTimestamp

public long getTimestamp()

Gets the document modified timestamp property.

Overrides:

getTimestamp in class Response

Returns:

document modified timestamp

getPaTimestamp

public long getPaTimestamp()

Gets the PrefAnswer modified timestamp property.

Returns:

PrefAnswer modified timestamp

getPopularity

public int getPopularity()

Returns:

the popularity, 0 if this isn't a pa

getVicDocTypeAsString

public java.lang.String getVicDocTypeAsString()

Gets the string representation of the doc type of this result for use in a View in Context command. All types are HTML unless they are PDF.

Returns:

document type

getVicDocType

public int getVicDocType()

Gets the doc type of this result for use in a View in Context command. All types are HTML unless they are PDF.

Returns:

document type

getTitle

public java.lang.String getTitle()

Gets the title property.

Overrides:

getTitle in class Response

Returns:

current title

getFullTitle

public java.lang.String getFullTitle()

getIsTruncated

public boolean getIsTruncated()

setIsTruncated

public void setIsTruncated(boolean isTruncated)

getResponseId

public com.primus.frameworks.UniqueID getResponseId()

Gets the responseId property.

Overrides:

getResponseId in class Response

Returns:

response Id

getDebugString

public java.lang.String getDebugString()

Gets the debug String.

Returns:

debug string

getDebugNodeString

public java.lang.String getDebugNodeString()

Gets the debug String.

Returns:

debug string

getNormalizedResponse

public java.lang.String getNormalizedResponse()

Gets the normalized response String.

Returns:

normString string

setNormalizedResponse

public void setNormalizedResponse(java.lang.String norm)

Sets the normalized response String.

setDebugNodeString

public void setDebugNodeString(java.lang.String ds)

Sets the debug String.

setPaTimestamp

public void setPaTimestamp(long paTimestamp)

Parameters:

paTimestamp -

getPaTimestampString

public java.lang.String getPaTimestampString()

Gets the prefanswer modify timestamp as a String.

Overrides:

getPaTimestampString in class Response

Returns:

timestamp string

toString

public java.lang.String toString()

Standard toString method.

Overrides:

toString in class java.lang.Object

Returns:

string representation of this value object

toSummaryString

public java.lang.String toSummaryString()

Standard toString method, but returns summaries of long text fields. This makes debugging easier.

Returns:

string summary representation of this value object

hashCode

public int hashCode()

Standard hash code method.

Overrides:

hashCode in class java.lang.Object

Returns:

hash code for this instance

getSummary

public java.lang.String getSummary()

byDocScore

public java.util.Comparator byDocScore()

byTimestamp

public java.util.Comparator byTimestamp()

getRankCalc

public java.lang.String getRankCalc()

Returns:

Result of ranking configuration calculation

setRankCalc

public void setRankCalc(java.lang.String rankCalc)

Parameters:

rankCalc - Result of ranking configuration calculation

getLang

public java.lang.String getLang()

setLang

public void setLang(java.lang.String pLang)