|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.gsaapi.GSAResult
The Java binding to the result element of the XML response received from querying the GSA.
Constructor Summary | |
GSAResult()
constructor is intended for internal use only. |
Method Summary | |
void |
addField(java.lang.String key,
java.lang.String value)
Add an "additional" field-value pair. |
void |
addMeta(java.lang.String key,
java.lang.String value)
Add a meta field value pair. |
java.lang.String |
getCacheDocEncoding()
If a cached version is available, the encoding of the cached document. |
java.lang.String |
getCacheDocId()
returns the cache identifier for the document. |
java.lang.String |
getCacheDocSize()
String representing the value of the cached documents approximate size. |
java.lang.String |
getEscapedUrl()
return the escaped url as returned by the GSA. |
java.lang.String |
getField(java.lang.String name)
Get the value for the "additional" field. |
java.util.Map |
getFields()
get the map of "additional" fields associated with this result (if any). |
int |
getIndentation()
Get the suggested indentation level. |
java.lang.String |
getLanguage()
get the language associated with this result. |
java.lang.String |
getMeta(java.lang.String name)
get the value for the meta (custom) field. |
java.util.Map |
getMetas()
get the map of meta information associated with this result (if any). |
java.lang.String |
getMimeType()
Get the result mime type. |
int |
getRating()
0-10 relevance rating for this result. |
java.lang.String |
getSummary()
get result summary. |
java.lang.String |
getTitle()
get result title. |
java.lang.String |
getUrl()
get url for the result. |
void |
setCacheDocEncoding(java.lang.String cacheDocEncoding)
set the value for encoding of the cached document. |
void |
setCacheDocId(java.lang.String cacheDocId)
set value for the cache identifier for the document. |
void |
setCacheDocSize(java.lang.String cacheDocSize)
set the value for the cached documents approximate size. |
void |
setEscapedUrl(java.lang.String escapedUrl)
set the value for the escaped url String. |
void |
setFields(java.util.Map fields)
Set the "additional" field-values associated with this result if any. |
void |
setIndentation(int indentation)
set the indentation for this result item (suggestion). |
void |
setLanguage(java.lang.String language)
set the language that the result is supposed to be of. |
void |
setMetas(java.util.Map metas)
set the meta field-values associated with this result if any. |
void |
setMimeType(java.lang.String mimeType)
Mime type of the result. |
void |
setRating(int rating)
Relevance rating as returned. |
void |
setSummary(java.lang.String summary)
Set the result summary. |
void |
setTitle(java.lang.String title)
Set the result title. |
void |
setUrl(java.lang.String url)
Set the content url for the result. |
java.lang.String |
toString()
toString method: creates a String representation of the object |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public GSAResult()
Method Detail |
public void setIndentation(int indentation)
indentation
- public void setLanguage(java.lang.String language)
language
- public void setMetas(java.util.Map metas)
metas
- public void addMeta(java.lang.String key, java.lang.String value)
key
- meta field key.value
- meta field value.public void setFields(java.util.Map fields)
fields
- Map of fields and their values.public void addField(java.lang.String key, java.lang.String value)
key
- field key.value
- field value.public void setMimeType(java.lang.String mimeType)
mimeType
- The mime type of the result.public void setRating(int rating)
rating
- The rating (a value between 0 and 10 inclusive).public void setSummary(java.lang.String summary)
summary
- The result summary.public void setTitle(java.lang.String title)
title
- The result title.public void setUrl(java.lang.String url)
url
- the content url for the result.public int getIndentation()
public java.lang.String getLanguage()
public java.util.Map getMetas()
public java.lang.String getMeta(java.lang.String name)
name
- The name of the meta field.
public java.util.Map getFields()
public java.lang.String getField(java.lang.String name)
name
- The name of the additional field.
public java.lang.String getMimeType()
public int getRating()
public java.lang.String getSummary()
public java.lang.String getTitle()
public java.lang.String getUrl()
public java.lang.String getCacheDocEncoding()
public void setCacheDocEncoding(java.lang.String cacheDocEncoding)
cacheDocEncoding
- public java.lang.String getCacheDocId()
public void setCacheDocId(java.lang.String cacheDocId)
cacheDocId
- public java.lang.String getCacheDocSize()
public void setCacheDocSize(java.lang.String cacheDocSize)
cacheDocSize
- public java.lang.String getEscapedUrl()
public void setEscapedUrl(java.lang.String escapedUrl)
escapedUrl
- public java.lang.String toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
© Copyright 2006 Inxight Software, Inc.