Oracle Ultra Search APIs
9.0.1

oracle.context.isearch.query
Class Document

java.lang.Object
  |
  +--oracle.context.isearch.query.Document

public class Document
extends java.lang.Object

Simple helper class that stores public data members representing various attributes of a document.

Since:
1.0.2

Field Summary
 java.lang.String author
          The document author.
 int dataGroupId
          The data group id that the data source of this document belongs to
 int dataSourceId
          The data source id that this document belongs to
 java.lang.String description
          A description of this document.
 java.lang.String language
          The language that the document was written in.
 java.sql.Date lastModified
          The last modified date.
 int length
          The length of the document in bytes.
 int score
          The hit score of this document pertaining to the query for which this document was a result of.
 java.lang.String title
          The document title.
 java.lang.String url
          The first Universal Resource Locator that leads to the actual document content represented by this Document object.
 java.lang.String url2
          The second Universal Resource Locator that leads to the actual content represented by this Document object.
 java.lang.String url3
          The third Universal Resource Locator that leads to the actual content represented by this Document object.
 
Constructor Summary
Document()
          Class constructor.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

url

public java.lang.String url
The first Universal Resource Locator that leads to the actual document content represented by this Document object.

The actual document content may be an HTML document on a website, an archived email MIME message, data in a database table row or a file accessible via the file system of the Ultra Search crawler host.

A document can have more than one URL that refers to it. For example, an HTML document can reside on the same server but be accessible via different URLs. Furthermore, multiple copies of the same HTML document may reside on different servers.

This Document object can have up to three URLs that reference the actual document content. If there are more than three URLs for this document, only the first three in the index are returned.


url2

public java.lang.String url2
The second Universal Resource Locator that leads to the actual content represented by this Document object.

url3

public java.lang.String url3
The third Universal Resource Locator that leads to the actual content represented by this Document object.

title

public java.lang.String title
The document title.

description

public java.lang.String description
A description of this document.

author

public java.lang.String author
The document author.

lastModified

public java.sql.Date lastModified
The last modified date.

length

public int length
The length of the document in bytes.

language

public java.lang.String language
The language that the document was written in.

score

public int score
The hit score of this document pertaining to the query for which this document was a result of.

dataSourceId

public int dataSourceId
The data source id that this document belongs to

dataGroupId

public int dataGroupId
The data group id that the data source of this document belongs to
Constructor Detail

Document

public Document()
Class constructor.

Oracle Ultra Search APIs
9.0.1