Skip navigation links

oracle.search.sdk.query
Interface DocumentInfo

public interface DocumentInfo

An interface representing information about a document that can be passed to a ResultFilterPlugin for:

• filtering out documents
• modifying the title and display URL returned with the search result

Note: Modifications to the title or display URL will not affect the information stored in the search index.

Method Summary

String	getAccessURL() Returns the access URL of the document.
int	getContentLength() Returns the length of the contents of the document.
String	getDisplayURL() Returns the display URL of the document.
Date	getLastModifiedDate() Returns the date of last modification of the document.
String	getTitle() Returns the title of the document.
void	setDisplayURL(String displayUrl) Modifies the document display URL returned as part of a search result.
void	setTitle(String title) Modifies the document title returned as part of a search result.

Method Detail

getTitle

String getTitle()

Returns the title of the document.

Returns:

title of document

setTitle

void setTitle(String title)

Modifies the document title returned as part of a search result. The document information stored in the search index will not be affected.

Parameters:

title - the new title

getDisplayURL

String getDisplayURL()

Returns the display URL of the document. This is the URL displayed to the search user as part of the search results.

Returns:

display URL of document

setDisplayURL

void setDisplayURL(String displayUrl)

Modifies the document display URL returned as part of a search result. The document information stored in the search index will not be affected.

Parameters:

displayUrl - the new display URL

getAccessURL

String getAccessURL()

Returns the access URL of the document. This is the URL used by the crawler to retrieve the document.

Returns:

access URL of document

getContentLength

int getContentLength()

Returns the length of the contents of the document.

Returns:

content length

getLastModifiedDate

Date getLastModifiedDate()

Returns the date of last modification of the document.

Returns:

date last modified

Skip navigation links