|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface that allows the portal to specify documents for retrieval from a backend repository.
Method Summary | |
IDocument |
attachToDocument(java.lang.String documentLocation,
java.lang.String locale,
java.lang.String signature,
DocumentFormat format)
Returns a specific document for further querying and retrieval. |
void |
initialize(DataSourceInfo dataInfo,
ICrawlerLog logger)
Sets up any resources required during the execution of the document retrieval. |
void |
shutdown()
Cleans up any resources used by the crawler. |
Method Detail |
public void initialize(DataSourceInfo dataInfo, ICrawlerLog logger) throws ServiceException
dataInfo
- SCI information set in the Data Source editor. Note: The names in the NamedValue
s in dataInfo will be uppercase.logger
- an implementation of the ServiceException
- if an error occurredpublic IDocument attachToDocument(java.lang.String documentLocation, java.lang.String locale, java.lang.String signature, DocumentFormat format) throws ServiceException
documentLocation
- the path to the requested document.
This could be a UNC path for a file crawler, or an application-specific string for other repositories.
In most cases, documentLocation is ChildDocument.getLocation
, except when submitting a remote document,
in which case the developer supplies the documentLocation.
Keep in mind that IDocumentProvider
does not have access to CrawlInfo
, so any crawler values required in
IDocumentProvider.attachToDocument
should be added to the location string in ChildDocument
to be parsed in attachToDocument
.locale
- the user's locale information to pass to the backendsignature
- the portal's last known signature (generally a last modified date) for this documentformat
- the DocumentFormat
flag indicating which kind
of retrieval to perform. This will only be DISPLAY if using DocFetch during clickthrough.
If using the FILE model of clickthrough, DocumentFormat
will be INDEX during both crawl and clickthrough.
IDocument
interface
NoLongerExistsException
- if the document has been removed. The portal will remove the document if this exception is thrown.
NotAvailableException
- if the document is temporarily unavailable. The portal will not remove the document if this exception is thrown.
NotInitializedException
- if the IDocumentProvider
is in an uninitialized state
AccessDeniedException
- if access to this document is denied. The portal will not remove the document if this exception is thrown.
ServiceException
- if an error occurredChildDocument.getLocation()
public void shutdown() throws ServiceException
ServiceException
- if an error occurred
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.