Skip navigation links

oracle.search.query.webservice.wssclient
Class ResultElement

java.lang.Object
oracle.search.query.webservice.wssclient.ResultElement

public class ResultElement

extends Object

ResultElement encapsulates an element (document) information in the hit-list.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="resultElement">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="author" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="contentLength" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="customAttributes" type="{http://search.oracle.com/Query}customAttribute" maxOccurs="unbounded" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="docID" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="fedID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="groups" type="{http://search.oracle.com/Query}dataGroup" maxOccurs="unbounded" minOccurs="0"/>
         <element name="hasDuplicate" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="infoSourceID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="infoSourcePath" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="isDuplicate" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="language" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="lastModified" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="mimetype" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="score" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="signature" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="snippet" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="title" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="url" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Constructor Summary

ResultElement()

Method Summary

String	getAuthor() Returns the author of the document.
Integer	getContentLength() Returns the content length of the document.
List	getCustomAttributes() Returns the non-default attributes of the document requested in the search methods.
String	getDescription() Returns the description of the document.
Integer	getDocID() Returns the ID of the document.
String	getFedID() Returns the ID of the federated instance to which the document belongs.
List	getGroups() Returns the data groups to which the document belongs.
String	getInfoSourceID() Returns the infosource ID of the document.
String	getInfoSourcePath() Returns the infosource path of the document.
String	getLanguage() Returns the language of the document.
javax.xml.datatype.XMLGregorianCalendar	getLastModified() Returns the last modified date of the document.
String	getMimetype() Returns the MIME type of the document.
Integer	getScore() Returns the relevance score of the document.
Long	getSignature() Returns the signature of the document.
String	getSnippet() Returns keywords in context (KWIC) of the document for the given query.
String	getTitle() Returns the title of the document.
String	getUrl() Returns the URL to access the document.
Boolean	isHasDuplicate() Returns the Boolean flag indicating if the document has one or more duplicate documents in the hit-list.
Boolean	isIsDuplicate() Returns a Boolean flag indicating if the document is a duplicate document of another document in the hit-list.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResultElement

public ResultElement()

Method Detail

getAuthor

public String getAuthor()

Returns the author of the document.

Returns:

author

getContentLength

public Integer getContentLength()

Returns the content length of the document.

Returns:

document size in bytes

getCustomAttributes

public List getCustomAttributes()

Returns the non-default attributes of the document requested in the search methods.

Returns:

list of CustomAttribute

getDescription

public String getDescription()

Returns the description of the document.

Returns:

description of the document

getDocID

public Integer getDocID()

Returns the ID of the document.

Returns:

document ID

getFedID

public String getFedID()

Returns the ID of the federated instance to which the document belongs.

Returns:

the ID of the federated instance

getGroups

public List getGroups()

Returns the data groups to which the document belongs.

Returns:

list of DataGroup

isHasDuplicate

public Boolean isHasDuplicate()

Returns the Boolean flag indicating if the document has one or more duplicate documents in the hit-list.

Returns:

has duplicate flag

getInfoSourceID

public String getInfoSourceID()

Returns the infosource ID of the document.

Returns:

infosource ID

getInfoSourcePath

public String getInfoSourcePath()

Returns the infosource path of the document.

Returns:

infosource path

isIsDuplicate

public Boolean isIsDuplicate()

Returns a Boolean flag indicating if the document is a duplicate document of another document in the hit-list.

Returns:

is duplicate flag

getLanguage

public String getLanguage()

Returns the language of the document.

Returns:

document language

getLastModified

public javax.xml.datatype.XMLGregorianCalendar getLastModified()

Returns the last modified date of the document.

Returns:

last modified date in XMLGregorianCalendar

getMimetype

public String getMimetype()

Returns the MIME type of the document.

Returns:

MIME type

getScore

public Integer getScore()

Returns the relevance score of the document.

Returns:

relevance score

getSignature

public Long getSignature()

Returns the signature of the document.

Returns:

document signature

getSnippet

public String getSnippet()

Returns keywords in context (KWIC) of the document for the given query.

Returns:

keywords in context

getTitle

public String getTitle()

Returns the title of the document.

Returns:

title

getUrl

public String getUrl()

Returns the URL to access the document.

Returns:

document URL string

Skip navigation links