Skip navigation links

oracle.search.query.webservice.client
Class ResultElement

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

All Implemented Interfaces:

Serializable

public class ResultElement

extends Object

implements Serializable

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

See Also:

Serialized Form

Constructor Summary

ResultElement()

ResultElement(String author, String description, String url, String snippet, String title, Date lastModified, String mimetype, Integer score, Integer docID, String language, Integer contentLength, Long signature, String infoSourceID, String infoSourcePath, DataGroup[] groups, Boolean isDuplicate, Boolean hasDuplicate, CustomAttribute[] customAttributes, String fedID)

Method Summary

String	getAuthor() Returns the author of the document.
Integer	getContentLength() Returns the content length of the document.
CustomAttribute[]	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.
DataGroup[]	getGroups() Returns the data groups to which the document belongs.
Boolean	getHasDuplicate() Returns a Boolean value indicating if the document has one or more duplicate documents in the hit-list.
String	getInfoSourceID() Returns the infosource ID of the document.
String	getInfoSourcePath() Returns the infosource path of the document.
Boolean	getIsDuplicate() Returns a Boolean value indicating if the document is a duplicate document of another document in the hit-list.
String	getLanguage() Returns the language of the document.
Date	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()

ResultElement

public ResultElement(String author,
                     String description,
                     String url,
                     String snippet,
                     String title,
                     Date lastModified,
                     String mimetype,
                     Integer score,
                     Integer docID,
                     String language,
                     Integer contentLength,
                     Long signature,
                     String infoSourceID,
                     String infoSourcePath,
                     DataGroup[] groups,
                     Boolean isDuplicate,
                     Boolean hasDuplicate,
                     CustomAttribute[] customAttributes,
                     String fedID)

Parameters:

author - author of the document

description - description of the document

url - URL to access the document

title - title of the document

lastModified - last modified date of the document

mimetype - MIME type of the document

score - relevance score of the document

docID - ID of the document

language - language of the document

contentLength - size of the document

signature - signature of the document

infoSourceID - infosource ID of the document

infoSourcePath - infosource path of the document

groups - source groups to which the documents belongs

isDuplicate - Boolean value indicating if the document is a duplicate of another document in the hit list

hasDuplicate - Boolean value indicating if the document has one or more duplicates in the hit list

customAttributes - custom (non-default) attributes of the document that were requested in the search methods

fedID - ID of the federated instance to which the document belongs

Method Detail

getAuthor

public String getAuthor()

Returns the author of the document.

getDescription

public String getDescription()

Returns the description of the document.

getUrl

public String getUrl()

Returns the URL to access the document.

getSnippet

public String getSnippet()

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

getTitle

public String getTitle()

Returns the title of the document.

getLastModified

public Date getLastModified()

Returns the last modified date of the document.

getMimetype

public String getMimetype()

Returns the MIME type of the document.

getScore

public Integer getScore()

Returns the relevance score of the document.

getDocID

public Integer getDocID()

Returns the ID of the document.

getLanguage

public String getLanguage()

Returns the language of the document.

getContentLength

public Integer getContentLength()

Returns the content length of the document.

getSignature

public Long getSignature()

Returns the signature of the document.

getInfoSourceID

public String getInfoSourceID()

Returns the infosource ID of the document.

getInfoSourcePath

public String getInfoSourcePath()

Returns the infosource path of the document.

getGroups

public DataGroup[] getGroups()

Returns the data groups to which the document belongs.

getIsDuplicate

public Boolean getIsDuplicate()

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

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

getHasDuplicate

public Boolean getHasDuplicate()

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

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

getFedID

public String getFedID()

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

getCustomAttributes

public CustomAttribute[] getCustomAttributes()

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

Skip navigation links