public abstract class AbstractCommitter extends Object implements ICommitter
ICommitter.commit()
method every time a given
queue size threshold has been reached. Both additions and deletions count
towards the same queue size.
It is still left to implementors to decide how to actually queue the
documents and how to perform commits.
Consider extending AbstractFileQueueCommitter
if you do not wish
to implement your own queue.
Subclasses implementing IXMLConfigurable
should allow this inner
configuration:
<queueSize>(max queue size before committing)</queueSize>
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_QUEUE_SIZE
Default queue size.
|
DEFAULT_DOCUMENT_REFERENCE
Constructor and Description |
---|
AbstractCommitter()
Constructor.
|
AbstractCommitter(int queueSize)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
int |
getQueueSize()
Gets the queue size.
|
int |
hashCode() |
void |
queueAdd(String reference,
File document,
Properties metadata)
Queues a new or modified document.
|
protected abstract void |
queueAddittion(String reference,
File document,
Properties metadata)
Queues a document to be added.
|
protected abstract void |
queueRemoval(String reference,
File document,
Properties metadata)
Queues a document to be deleted.
|
void |
queueRemove(String ref,
File document,
Properties metadata)
Queues a document for removal.
|
void |
setQueueSize(int queueSize)
Sets the queue size.
|
String |
toString() |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
commit
public static final int DEFAULT_QUEUE_SIZE
public AbstractCommitter()
public AbstractCommitter(int queueSize)
queueSize
- queue sizepublic int getQueueSize()
public void setQueueSize(int queueSize)
queueSize
- queue sizepublic final void queueAdd(String reference, File document, Properties metadata)
ICommitter
queueAdd
in interface ICommitter
reference
- document reference (e.g. URL)document
- text documentmetadata
- document metadataprotected abstract void queueAddittion(String reference, File document, Properties metadata)
reference
- document referencedocument
- document filemetadata
- document metadatapublic final void queueRemove(String ref, File document, Properties metadata)
ICommitter
queueRemove
in interface ICommitter
ref
- document reference (e.g. URL)document
- text documentmetadata
- document metadataprotected abstract void queueRemoval(String reference, File document, Properties metadata)
reference
- document referencedocument
- document filemetadata
- document metadataCopyright © 2009-2014 Norconex Inc.. All Rights Reserved.