com.norconex.committer
Interface ICommitter

All Superinterfaces:
Serializable
All Known Implementing Classes:
BaseCommitter, BatchableCommitter, FileSystemCommitter, FileSystemQueueCommitter

public interface ICommitter
extends Serializable

Commits documents to their final destination (e.g. search engine).

Author:
Pascal Essiembre

Field Summary
static String DEFAULT_DOCUMENT_REFERENCE
          The default document unique identifier (reference) is "doc.reference".
 
Method Summary
 void commit()
          Commits queued documents.
 void queueAdd(String reference, File document, Properties metadata)
          Queues a new or modified document.
 void queueRemove(String reference, File document, Properties metadata)
          Queues a document for removal.
 

Field Detail

DEFAULT_DOCUMENT_REFERENCE

static final String DEFAULT_DOCUMENT_REFERENCE
The default document unique identifier (reference) is "doc.reference". This value is set by default when using the Norconex Importer module. Concrete implementations should offer to overwrite this default value when appropriate.

See Also:
Constant Field Values
Method Detail

queueAdd

void queueAdd(String reference,
              File document,
              Properties metadata)
Queues a new or modified document. These queued documents should be sent to their target destination when commit is called.

Parameters:
reference - document reference (e.g. URL)
document - text document
metadata - document metadata

queueRemove

void queueRemove(String reference,
                 File document,
                 Properties metadata)
Queues a document for removal. These queued documents should be sent to their target destination for deletion when commit is called.

Parameters:
reference - document reference (e.g. URL)
document - text document
metadata - document metadata

commit

void commit()
Commits queued documents. Effectively apply the additions and removals.



Copyright © 2009-2013 Norconex Inc.. All Rights Reserved.