A B C D E F G H I L M N P Q R S T 

A

AbstractBatchCommitter - Class in com.norconex.committer
Commits documents to the target repository (e.g.
AbstractBatchCommitter() - Constructor for class com.norconex.committer.AbstractBatchCommitter
Constructor.
AbstractBatchCommitter(int) - Constructor for class com.norconex.committer.AbstractBatchCommitter
Constructor.
AbstractCommitter - Class in com.norconex.committer
Basic implementation invoking the ICommitter.commit() method every time a given queue size threshold has been reached.
AbstractCommitter() - Constructor for class com.norconex.committer.AbstractCommitter
Constructor.
AbstractCommitter(int) - Constructor for class com.norconex.committer.AbstractCommitter
Constructor.
AbstractFileQueueCommitter - Class in com.norconex.committer
Queues documents on filesystem, leaving only the committing of additions and deletions to implement.
AbstractFileQueueCommitter() - Constructor for class com.norconex.committer.AbstractFileQueueCommitter
Constructor.
AbstractFileQueueCommitter(int) - Constructor for class com.norconex.committer.AbstractFileQueueCommitter
Constructor.
AbstractMappedCommitter - Class in com.norconex.committer
A base class batching documents and offering mappings of source id and source content fields to target id and target content fields.
AbstractMappedCommitter() - Constructor for class com.norconex.committer.AbstractMappedCommitter
Creates a new instance.
AbstractMappedCommitter(int) - Constructor for class com.norconex.committer.AbstractMappedCommitter
Creates a new instance with given commit batch size.
addCommitter(ICommitter...) - Method in class com.norconex.committer.impl.MultiCommitter
Adds one or more committers.

B

BaseCommitter - Class in com.norconex.committer
Deprecated.
Since 1.1.0. Use AbstractMappedCommitter
BaseCommitter() - Constructor for class com.norconex.committer.BaseCommitter
Deprecated.
Constructor.
BaseCommitter(int) - Constructor for class com.norconex.committer.BaseCommitter
Deprecated.
Creates a new instance with the given batch size.
BatchableCommitter - Class in com.norconex.committer
Deprecated.
Since 1.1.0. Use AbstractCommitter
BatchableCommitter() - Constructor for class com.norconex.committer.BatchableCommitter
Deprecated.
Constructor.
BatchableCommitter(int) - Constructor for class com.norconex.committer.BatchableCommitter
Deprecated.
Creates a new instance initialized to the given batch size.

C

com.norconex.committer - package com.norconex.committer
 
com.norconex.committer.impl - package com.norconex.committer.impl
 
commit() - Method in class com.norconex.committer.AbstractFileQueueCommitter
 
commit() - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
 
commit() - Method in interface com.norconex.committer.ICommitter
Commits queued documents.
commit() - Method in class com.norconex.committer.impl.FileSystemCommitter
 
commit() - Method in class com.norconex.committer.impl.MultiCommitter
 
commit() - Method in class com.norconex.committer.impl.NilCommitter
 
commitAddedDocument(FileSystemQueueCommitter.QueuedAddedDocument) - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
Allow subclasses to commit a file to be added.
commitAddition(IAddOperation) - Method in class com.norconex.committer.AbstractBatchCommitter
 
commitAddition(IAddOperation) - Method in class com.norconex.committer.AbstractFileQueueCommitter
Allow subclasses to commit a file to be added.
commitBatch(List<ICommitOperation>) - Method in class com.norconex.committer.AbstractBatchCommitter
Commits a group of operation.
commitComplete() - Method in class com.norconex.committer.AbstractBatchCommitter
 
commitComplete() - Method in class com.norconex.committer.AbstractFileQueueCommitter
Allow subclasses to operate upon the end of the commit operation.
commitComplete() - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
Allow subclasses to operate upon the end of the commit operation.
commitDeletedDocument(FileSystemQueueCommitter.QueuedDeletedDocument) - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
Allow subclasses to commit a file to be deleted.
commitDeletion(IDeleteOperation) - Method in class com.norconex.committer.AbstractBatchCommitter
 
commitDeletion(IDeleteOperation) - Method in class com.norconex.committer.AbstractFileQueueCommitter
Allow subclasses to commit a file to be deleted.
CommitterException - Exception in com.norconex.committer
Triggered when something went wrong with committing.
CommitterException() - Constructor for exception com.norconex.committer.CommitterException
Constructor.
CommitterException(String) - Constructor for exception com.norconex.committer.CommitterException
Constructor.
CommitterException(Throwable) - Constructor for exception com.norconex.committer.CommitterException
Constructor.
CommitterException(String, Throwable) - Constructor for exception com.norconex.committer.CommitterException
Constructor.

D

DEFAULT_BATCH_SIZE - Static variable in class com.norconex.committer.BatchableCommitter
Deprecated.
Default batch size.
DEFAULT_COMMIT_BATCH_SIZE - Static variable in class com.norconex.committer.AbstractBatchCommitter
Default commit batch size.
DEFAULT_DIRECTORY - Static variable in class com.norconex.committer.impl.FileSystemCommitter
Default committer directory
DEFAULT_DOCUMENT_REFERENCE - Static variable in interface com.norconex.committer.ICommitter
The default document unique identifier (reference) is "document.reference".
DEFAULT_QUEUE_DIR - Static variable in class com.norconex.committer.AbstractFileQueueCommitter
Default directory where to queue files.
DEFAULT_QUEUE_DIR - Static variable in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
Default queue directory.
DEFAULT_QUEUE_SIZE - Static variable in class com.norconex.committer.AbstractCommitter
Default queue size.
delete() - Method in class com.norconex.committer.FileAddOperation
 
delete() - Method in class com.norconex.committer.FileDeleteOperation
 
delete() - Method in interface com.norconex.committer.ICommitOperation
Deletes the operation.
deleteFromQueue() - Method in class com.norconex.committer.FileSystemQueueCommitter.QueuedAddedDocument
Deprecated.
Deletes the document from queue.
deleteFromQueue() - Method in class com.norconex.committer.FileSystemQueueCommitter.QueuedDeletedDocument
Deprecated.
Deletes document from queue.

E

equals(Object) - Method in class com.norconex.committer.AbstractBatchCommitter
 
equals(Object) - Method in class com.norconex.committer.AbstractCommitter
 
equals(Object) - Method in class com.norconex.committer.AbstractFileQueueCommitter
 
equals(Object) - Method in class com.norconex.committer.AbstractMappedCommitter
 
equals(Object) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
 
equals(Object) - Method in class com.norconex.committer.BatchableCommitter
Deprecated.
 
equals(Object) - Method in class com.norconex.committer.FileAddOperation
 
equals(Object) - Method in class com.norconex.committer.FileDeleteOperation
 
equals(Object) - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
 
equals(Object) - Method in class com.norconex.committer.impl.FileSystemCommitter
 

F

FileAddOperation - Class in com.norconex.committer
A file-based addition operation.
FileAddOperation(File) - Constructor for class com.norconex.committer.FileAddOperation
Constructor.
FileDeleteOperation - Class in com.norconex.committer
A file-based deletion operation.
FileDeleteOperation(File) - Constructor for class com.norconex.committer.FileDeleteOperation
Constructor.
FileSystemCommitter - Class in com.norconex.committer.impl
Commits a copy of files on the filesystem.
FileSystemCommitter() - Constructor for class com.norconex.committer.impl.FileSystemCommitter
 
FileSystemQueueCommitter - Class in com.norconex.committer
Deprecated.
FileSystemQueueCommitter() - Constructor for class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
Constructor.
FileSystemQueueCommitter(int) - Constructor for class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
Constructor.
FileSystemQueueCommitter.QueuedAddedDocument - Class in com.norconex.committer
Deprecated.
Class representing a document addition.
FileSystemQueueCommitter.QueuedDeletedDocument - Class in com.norconex.committer
Deprecated.
Class representing a document deletion.

G

getAddDir() - Method in class com.norconex.committer.impl.FileSystemCommitter
Gets the directory where documents to be added are stored.
getBatchSize() - Method in class com.norconex.committer.BatchableCommitter
Deprecated.
Gets the batch size.
getCommitBatchSize() - Method in class com.norconex.committer.AbstractBatchCommitter
Gets the commit batch size.
getCommitters() - Method in class com.norconex.committer.impl.MultiCommitter
Gets nested committers.
getContentSourceField() - Method in class com.norconex.committer.AbstractMappedCommitter
Gets the source field name holding the document content.
getContentSourceField() - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Gets the source field name holding the document content.
getContentStream() - Method in class com.norconex.committer.FileAddOperation
 
getContentStream() - Method in class com.norconex.committer.FileSystemQueueCommitter.QueuedAddedDocument
Deprecated.
Gets the content as a stream.
getContentStream() - Method in interface com.norconex.committer.IAddOperation
Gets the content as a stream
getContentTargetField() - Method in class com.norconex.committer.AbstractMappedCommitter
Gets the target field where to store the document content.
getContentTargetField() - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Gets the target field where to store the document content.
getDirectory() - Method in class com.norconex.committer.impl.FileSystemCommitter
Gets the directory where files are committed.
getIdSourceField() - Method in class com.norconex.committer.AbstractMappedCommitter
Gets the source field name holding the unique identifier.
getIdSourceField() - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Gets the source field name holding the unique identifier.
getIdTargetField() - Method in class com.norconex.committer.AbstractMappedCommitter
Gets the target field name to store the unique identifier.
getIdTargetField() - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Gets the target field name to store the unique identifier.
getMaxRetries() - Method in class com.norconex.committer.AbstractBatchCommitter
Gets the maximum number of retries upon batch commit failure.
getMaxRetryWait() - Method in class com.norconex.committer.AbstractBatchCommitter
Gets the maximum wait time before retrying a failed commit.
getMetadata() - Method in class com.norconex.committer.FileAddOperation
 
getMetadata() - Method in class com.norconex.committer.FileSystemQueueCommitter.QueuedAddedDocument
Deprecated.
Gets the metadata.
getMetadata() - Method in interface com.norconex.committer.IAddOperation
Gets the metadata.
getQueueDir() - Method in class com.norconex.committer.AbstractFileQueueCommitter
Gets the directory where queued files are stored.
getQueueDir() - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
Gets the queue directory.
getQueueSize() - Method in class com.norconex.committer.AbstractCommitter
Gets the queue size.
getReference() - Method in class com.norconex.committer.FileDeleteOperation
 
getReference() - Method in class com.norconex.committer.FileSystemQueueCommitter.QueuedDeletedDocument
Deprecated.
Document reference.
getReference() - Method in interface com.norconex.committer.IDeleteOperation
Gets the document reference.
getRemoveDir() - Method in class com.norconex.committer.impl.FileSystemCommitter
Gets the directory where documents to be removed are stored.

H

hashCode() - Method in class com.norconex.committer.AbstractBatchCommitter
 
hashCode() - Method in class com.norconex.committer.AbstractCommitter
 
hashCode() - Method in class com.norconex.committer.AbstractFileQueueCommitter
 
hashCode() - Method in class com.norconex.committer.AbstractMappedCommitter
 
hashCode() - Method in class com.norconex.committer.BaseCommitter
Deprecated.
 
hashCode() - Method in class com.norconex.committer.BatchableCommitter
Deprecated.
 
hashCode() - Method in class com.norconex.committer.FileAddOperation
 
hashCode() - Method in class com.norconex.committer.FileDeleteOperation
 
hashCode() - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
 
hashCode() - Method in class com.norconex.committer.impl.FileSystemCommitter
 

I

IAddOperation - Interface in com.norconex.committer
Operation representing a new or updated document to be added to the target repository.
ICommitOperation - Interface in com.norconex.committer
Implementations represent the different types of commit operations that can take place on a remote repository, and hold all necessary information for a successful commit.
ICommitter - Interface in com.norconex.committer
Commits documents to their final destination (e.g.
IDeleteOperation - Interface in com.norconex.committer
Operation representing a document to be deleted from the target repository.
isKeepContentSourceField() - Method in class com.norconex.committer.AbstractMappedCommitter
Whether to keep the content source field or not, once mapped.
isKeepContentSourceField() - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Whether to keep the content source field or not, once mapped.
isKeepIdSourceField() - Method in class com.norconex.committer.AbstractMappedCommitter
Whether to keep the ID source field or not, once mapped.
isKeepIdSourceField() - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Whether to keep the ID source field or not, once mapped.

L

loadFromXML(Reader) - Method in class com.norconex.committer.AbstractMappedCommitter
 
loadFromXml(XMLConfiguration) - Method in class com.norconex.committer.AbstractMappedCommitter
Allows subclasses to load their config from xml
loadFromXML(Reader) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
 
loadFromXml(XMLConfiguration) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Allows subclasses to load their config from xml
loadFromXML(Reader) - Method in class com.norconex.committer.impl.FileSystemCommitter
 
loadFromXML(Reader) - Method in class com.norconex.committer.impl.MultiCommitter
 

M

MultiCommitter - Class in com.norconex.committer.impl
This committer allows you to define user many committers as one.
MultiCommitter() - Constructor for class com.norconex.committer.impl.MultiCommitter
Constructor.
MultiCommitter(List<ICommitter>) - Constructor for class com.norconex.committer.impl.MultiCommitter
Constructor.

N

NilCommitter - Class in com.norconex.committer.impl
A dummy Committer that does nothing but logging to INFO (log4j) how many documents were queued (in batch of 100) so far, or committed (but fake).
NilCommitter() - Constructor for class com.norconex.committer.impl.NilCommitter
Constructor.

P

preCommitAddedDocument(FileSystemQueueCommitter.QueuedAddedDocument) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
 
preCommitAddedDocument(FileSystemQueueCommitter.QueuedAddedDocument) - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
Optionally performs operations on a document to be added before actually committing it.
preCommitDeletedDocument(FileSystemQueueCommitter.QueuedDeletedDocument) - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
Optionally performs operations on a document to be deleted before actually committing it.
prepareCommitAddition(IAddOperation) - Method in class com.norconex.committer.AbstractFileQueueCommitter
Optionally performs actions on a document to be added before actually committing it.
prepareCommitAddition(IAddOperation) - Method in class com.norconex.committer.AbstractMappedCommitter
 
prepareCommitDeletion(IDeleteOperation) - Method in class com.norconex.committer.AbstractFileQueueCommitter
Optionally performs operations on a document to be deleted before actually committing it.

Q

queueAdd(String, File, Properties) - Method in class com.norconex.committer.AbstractCommitter
 
queueAdd(String, File, Properties) - Method in class com.norconex.committer.BatchableCommitter
Deprecated.
 
queueAdd(String, File, Properties) - Method in interface com.norconex.committer.ICommitter
Queues a new or modified document.
queueAdd(String, File, Properties) - Method in class com.norconex.committer.impl.FileSystemCommitter
 
queueAdd(String, File, Properties) - Method in class com.norconex.committer.impl.MultiCommitter
 
queueAdd(String, File, Properties) - Method in class com.norconex.committer.impl.NilCommitter
 
queueAddittion(String, File, Properties) - Method in class com.norconex.committer.AbstractCommitter
Queues a document to be added.
queueAddittion(String, File, Properties) - Method in class com.norconex.committer.AbstractFileQueueCommitter
 
queueBatchableAdd(String, File, Properties) - Method in class com.norconex.committer.BatchableCommitter
Deprecated.
Queues a document to be added.
queueBatchableAdd(String, File, Properties) - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
 
queueBatchableRemove(String, File, Properties) - Method in class com.norconex.committer.BatchableCommitter
Deprecated.
Queues a document to be deleted.
queueBatchableRemove(String, File, Properties) - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
 
queueRemoval(String, File, Properties) - Method in class com.norconex.committer.AbstractCommitter
Queues a document to be deleted.
queueRemoval(String, File, Properties) - Method in class com.norconex.committer.AbstractFileQueueCommitter
 
queueRemove(String, File, Properties) - Method in class com.norconex.committer.AbstractCommitter
 
queueRemove(String, File, Properties) - Method in class com.norconex.committer.BatchableCommitter
Deprecated.
 
queueRemove(String, File, Properties) - Method in interface com.norconex.committer.ICommitter
Queues a document for removal.
queueRemove(String, File, Properties) - Method in class com.norconex.committer.impl.FileSystemCommitter
 
queueRemove(String, File, Properties) - Method in class com.norconex.committer.impl.MultiCommitter
 
queueRemove(String, File, Properties) - Method in class com.norconex.committer.impl.NilCommitter
 

R

removeCommitter(ICommitter...) - Method in class com.norconex.committer.impl.MultiCommitter
Removes one or more committers.

S

saveToXML(Writer) - Method in class com.norconex.committer.AbstractMappedCommitter
 
saveToXML(XMLStreamWriter) - Method in class com.norconex.committer.AbstractMappedCommitter
Allows subclasses to write their config to xml
saveToXML(Writer) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
 
saveToXML(XMLStreamWriter) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Allows subclasses to write their configuration to XML.
saveToXML(Writer) - Method in class com.norconex.committer.impl.FileSystemCommitter
 
saveToXML(Writer) - Method in class com.norconex.committer.impl.MultiCommitter
 
setBatchSize(int) - Method in class com.norconex.committer.BatchableCommitter
Deprecated.
Sets the batch size.
setCommitBatchSize(int) - Method in class com.norconex.committer.AbstractBatchCommitter
Sets the commit batch size.
setContentSourceField(String) - Method in class com.norconex.committer.AbstractMappedCommitter
Sets the source field name holding the document content.
setContentSourceField(String) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Sets the source field name holding the document content.
setContentTargetField(String) - Method in class com.norconex.committer.AbstractMappedCommitter
Sets the target field where to store the document content.
setContentTargetField(String) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Sets the target field where to store the document content.
setDirectory(String) - Method in class com.norconex.committer.impl.FileSystemCommitter
Sets the directory where files are committed.
setIdSourceField(String) - Method in class com.norconex.committer.AbstractMappedCommitter
sets the source field name holding the unique identifier.
setIdSourceField(String) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
sets the source field name holding the unique identifier.
setIdTargetField(String) - Method in class com.norconex.committer.AbstractMappedCommitter
Sets the target field name to store the unique identifier.
setIdTargetField(String) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Sets the target field name to store the unique identifier.
setKeepContentSourceField(boolean) - Method in class com.norconex.committer.AbstractMappedCommitter
Sets whether to keep the content source field or not, once mapped.
setKeepContentSourceField(boolean) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Sets whether to keep the content source field or not, once mapped.
setKeepIdSourceField(boolean) - Method in class com.norconex.committer.AbstractMappedCommitter
Sets whether to keep the ID source field or not, once mapped.
setKeepIdSourceField(boolean) - Method in class com.norconex.committer.BaseCommitter
Deprecated.
Sets whether to keep the ID source field or not, once mapped.
setMaxRetries(int) - Method in class com.norconex.committer.AbstractBatchCommitter
Sets the maximum number of retries upon batch commit failure.
setMaxRetryWait(long) - Method in class com.norconex.committer.AbstractBatchCommitter
Sets the maximum wait time before retrying a failed commit.
setQueueDir(String) - Method in class com.norconex.committer.AbstractFileQueueCommitter
Sets the directory where queued files are stored.
setQueueDir(String) - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
Sets the queue directory.
setQueueSize(int) - Method in class com.norconex.committer.AbstractCommitter
Sets the queue size.

T

toString() - Method in class com.norconex.committer.AbstractBatchCommitter
 
toString() - Method in class com.norconex.committer.AbstractCommitter
 
toString() - Method in class com.norconex.committer.AbstractFileQueueCommitter
 
toString() - Method in class com.norconex.committer.AbstractMappedCommitter
 
toString() - Method in class com.norconex.committer.BaseCommitter
Deprecated.
 
toString() - Method in class com.norconex.committer.BatchableCommitter
Deprecated.
 
toString() - Method in class com.norconex.committer.FileAddOperation
 
toString() - Method in class com.norconex.committer.FileDeleteOperation
 
toString() - Method in class com.norconex.committer.FileSystemQueueCommitter
Deprecated.
 
toString() - Method in class com.norconex.committer.impl.FileSystemCommitter
 
A B C D E F G H I L M N P Q R S T 

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