|
Oracle Secure Enterprise Search Java API Reference 11g Release 1 (11.1.2.0.0) E14433-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentContainer
DocumentContainer is an interface used by a crawler plug-in to submit or retrieve document information.
Field Summary | |
---|---|
static int |
STATUS_ACCESS_FORBIDDEN Access to this document is forbidden. |
static int |
STATUS_AUTH_REQUIRED Authorization is required to access this document. |
static int |
STATUS_BAD_GATEWAY |
static int |
STATUS_BAD_REQUEST |
static int |
STATUS_CANNOT_READ The document has no contents. |
static int |
STATUS_CONNECTION_REFUSED The connection was refused when accessing this document. |
static int |
STATUS_DOC_BOUNDARY_RULE_EXCLUDED The document was excluded based on boundary rules. |
static int |
STATUS_DOC_MIME_TYPE_EXCLUDED The document was excluded based on MIME type. |
static int |
STATUS_DOC_SIZE_TOO_BIG The document was too big to crawl. |
static int |
STATUS_DUPLICATE_DOC A duplicate document exists and will be ignored. |
static int |
STATUS_EMPTY_DOC The document has no contents. |
static int |
STATUS_FETCH_ERROR The document cannot be retrieved. |
static int |
STATUS_FILTER_ERROR The document cannot be filtered. |
static int |
STATUS_IO_EXCEPTION An I/O exception occurred when processing this document. |
static int |
STATUS_LOGIN_FAILED Log-in failed for this document. |
static int |
STATUS_NOTFOUND The document cannot be found. |
static int |
STATUS_OK_BUT_NO_INDEX The document is valid, but do not index it yet. |
static int |
STATUS_OK_CRAWLED The document was crawled successfully. |
static int |
STATUS_OK_FOR_INDEX The document is ready to be indexed. |
static int |
STATUS_OUT_OF_MEMORY An out-of-memory error occurred when processing this document. |
static int |
STATUS_PROXY_REQUIRED |
static int |
STATUS_READ_TIMEOUT Read timeout on this document. |
static int |
STATUS_REQUEST_TIMEOUT |
static int |
STATUS_SERVER_ERROR The server had a problem delivering this document. |
static int |
STATUS_STORE_USER |
Method Summary | |
---|---|
void |
addAttachment(String name, InputStream doc, String contentType) |
void |
addAttachment(String name, Reader doc, String contentType) Adds a text document attachment. |
void |
clearAttachments() Removes all attachments. |
InputStream |
getBinaryDocumentStream() Gets the original document content for binary file. |
Reader |
getDocumentReader() Gets the reader for the data that was set in the documentContainer. |
int |
getDocumentStatus() Gets the status of the document (DocumentContainer.STATUS*). |
InputStream |
getDocumentStream() Gets the stream for the data that was set in the documentContainer. |
DocumentMetadata |
getMetadata() Get the metadata object associated with this document container |
void |
setDocument(InputStream doc) Sets a document using the InputStream. |
void |
setDocument(Reader doc) Sets the document to be processed. |
void |
setDocumentStatus(int status) Set the status of the document. |
void |
setMetadata(DocumentMetadata meta) Sets the Document Metadata object. |
Field Detail |
---|
static final int STATUS_OK_FOR_INDEX
static final int STATUS_BAD_REQUEST
static final int STATUS_AUTH_REQUIRED
static final int STATUS_ACCESS_FORBIDDEN
static final int STATUS_NOTFOUND
static final int STATUS_PROXY_REQUIRED
static final int STATUS_REQUEST_TIMEOUT
static final int STATUS_SERVER_ERROR
static final int STATUS_BAD_GATEWAY
static final int STATUS_FETCH_ERROR
static final int STATUS_READ_TIMEOUT
static final int STATUS_FILTER_ERROR
static final int STATUS_OUT_OF_MEMORY
static final int STATUS_IO_EXCEPTION
static final int STATUS_CONNECTION_REFUSED
static final int STATUS_DUPLICATE_DOC
static final int STATUS_EMPTY_DOC
static final int STATUS_LOGIN_FAILED
static final int STATUS_OK_BUT_NO_INDEX
static final int STATUS_OK_CRAWLED
static final int STATUS_CANNOT_READ
static final int STATUS_DOC_SIZE_TOO_BIG
static final int STATUS_DOC_MIME_TYPE_EXCLUDED
static final int STATUS_DOC_BOUNDARY_RULE_EXCLUDED
static final int STATUS_STORE_USER
Method Detail |
---|
void setMetadata(DocumentMetadata meta)
meta
- the metadata objectDocumentMetadata getMetadata()
Reader getDocumentReader()
InputStream getDocumentStream()
InputStream getBinaryDocumentStream()
void setDocument(Reader doc)
doc
- the reader to read the documentvoid setDocument(InputStream doc)
doc
- the input stream to read the documentvoid addAttachment(String name, InputStream doc, String contentType)
name
- the name of the attachment; null if unknowndoc
- the input stream to read the attachmentcontentType
- the MIME type of the attachment, or null if unknownvoid addAttachment(String name, Reader doc, String contentType)
name
- the name of the attachment, or null if unknown.doc
- the input text reader to read the attachmentcontentType
- the MIME type of the attachment, or null if unknownvoid clearAttachments()
int getDocumentStatus()
void setDocumentStatus(int status) throws ProcessingException
status
- the document status codeProcessingException
|
Oracle Secure Enterprise Search Java API Reference 11g Release 1 (11.1.2.0.0) E14433-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |