|
Oracle® Ultra Search Java API Reference 11g Release 1 (11.1) B28329-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentService
DocumentService is an interface used by a document service agent to submit document attributes and/or document contents to the crawler
Field Summary | |
---|---|
static int |
FOLLOW_AND_INDEX |
static int |
FOLLOW_AND_NO_INDEX |
static int |
FOLLOW_UP |
static int |
NO_CHANGE status codes for doService |
static int |
NO_FOLLOW_AND_INDEX |
static int |
NO_FOLLOW_AND_NO_INDEX |
static int |
USE_CURRENT status codes for getRobotControl |
Method Summary | |
---|---|
void |
close() Shut down the agent |
int |
doService(java.lang.String documentUrl, int urlId, java.io.Reader docReader) Ask the agent to prepare for fetching of document URL and its attribute from the data source. |
UrlData |
getAttribute(int urlId) Set the attributes of the document identified by urlId |
java.io.Reader |
getContents(int urlId) Get the new contents of the document |
int |
getRobotControl(int urlId) Get the attributes of the document identified by urlId |
void |
open(DataSourceParams params, java.io.PrintWriter log) Initialize the document service agent |
void |
received(int urlId) Called after finishing work with the target document to allow the agent to do any clean up work associate with its service |
Field Detail |
---|
static final int NO_CHANGE
static final int FOLLOW_UP
static final int USE_CURRENT
static final int FOLLOW_AND_INDEX
static final int FOLLOW_AND_NO_INDEX
static final int NO_FOLLOW_AND_INDEX
static final int NO_FOLLOW_AND_NO_INDEX
Method Detail |
---|
void open(DataSourceParams params, java.io.PrintWriter log) throws AgentException
params
- the agent parameterslog
- the crawler log fileAgentException
- if unable to initialize the agentint doService(java.lang.String documentUrl, int urlId, java.io.Reader docReader) throws AgentException
documentUrl
- the URL string of the documenturlId
- the URL id associated with this documentdocReader
- Reader access to the documentAgentException
- if unable to process the document. Throw fatal agent exception to stop the crawler. Throw warning agent exception for warning.UrlData getAttribute(int urlId)
urlId
- URL idint getRobotControl(int urlId)
urlId
- URL idjava.io.Reader getContents(int urlId)
urlId
- URL idvoid received(int urlId) throws AgentException
AgentException
- for any error the crawler should be aware ofvoid close() throws AgentException
AgentException
- if unable to close the agent
|
Oracle® Ultra Search Java API Reference 11g Release 1 (11.1) B28329-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |