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

A

AbstractBatchCommitter - Class in com.norconex.committer.core

Commits documents to the target repository (e.g.

AbstractBatchCommitter() - Constructor for class com.norconex.committer.core.AbstractBatchCommitter

Constructor.

AbstractBatchCommitter(int) - Constructor for class com.norconex.committer.core.AbstractBatchCommitter

Constructor.

AbstractCommitter - Class in com.norconex.committer.core

Basic implementation invoking the ICommitter.commit() method every time a given queue size threshold has been reached.

AbstractCommitter() - Constructor for class com.norconex.committer.core.AbstractCommitter

Constructor.

AbstractCommitter(int) - Constructor for class com.norconex.committer.core.AbstractCommitter

Constructor.

AbstractFileQueueCommitter - Class in com.norconex.committer.core

Queues documents on filesystem, leaving only the committing of additions and deletions to implement.

AbstractFileQueueCommitter() - Constructor for class com.norconex.committer.core.AbstractFileQueueCommitter

Constructor.

AbstractFileQueueCommitter(int) - Constructor for class com.norconex.committer.core.AbstractFileQueueCommitter

Constructor.

AbstractMappedCommitter - Class in com.norconex.committer.core

A base class batching documents and offering mappings of source reference and source content fields to target reference and target content fields.

AbstractMappedCommitter() - Constructor for class com.norconex.committer.core.AbstractMappedCommitter

Creates a new instance.

AbstractMappedCommitter(int) - Constructor for class com.norconex.committer.core.AbstractMappedCommitter

Creates a new instance with given commit batch size.

add(String, InputStream, Properties) - Method in class com.norconex.committer.core.AbstractCommitter

add(String, InputStream, Properties) - Method in interface com.norconex.committer.core.ICommitter

Adds a new or modified document to the target destination.

add(String, InputStream, Properties) - Method in class com.norconex.committer.core.impl.FileSystemCommitter

add(String, InputStream, Properties) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

add(String, InputStream, Properties) - Method in class com.norconex.committer.core.impl.MultiCommitter

add(String, InputStream, Properties) - Method in class com.norconex.committer.core.impl.NilCommitter

add(String, InputStream, Properties) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

addCommitter(ICommitter...) - Method in class com.norconex.committer.core.impl.MultiCommitter

Adds one or more committers.

C

com.norconex.committer.core - package com.norconex.committer.core

com.norconex.committer.core.impl - package com.norconex.committer.core.impl

commit() - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

commit() - Method in interface com.norconex.committer.core.ICommitter

Commits documents.

commit() - Method in class com.norconex.committer.core.impl.FileSystemCommitter

commit() - Method in class com.norconex.committer.core.impl.JSONFileCommitter

commit() - Method in class com.norconex.committer.core.impl.MultiCommitter

commit() - Method in class com.norconex.committer.core.impl.NilCommitter

commit() - Method in class com.norconex.committer.core.impl.XMLFileCommitter

commitAddition(IAddOperation) - Method in class com.norconex.committer.core.AbstractBatchCommitter

commitAddition(IAddOperation) - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

Allow subclasses to commit a file to be added.

commitBatch(List<ICommitOperation>) - Method in class com.norconex.committer.core.AbstractBatchCommitter

Commits a group of operation.

commitComplete() - Method in class com.norconex.committer.core.AbstractBatchCommitter

commitComplete() - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

Allow subclasses to operate upon the end of the commit operation.

commitDeletion(IDeleteOperation) - Method in class com.norconex.committer.core.AbstractBatchCommitter

commitDeletion(IDeleteOperation) - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

Allow subclasses to commit a file to be deleted.

CommitterException - Exception in com.norconex.committer.core

Triggered when something went wrong with committing.

CommitterException() - Constructor for exception com.norconex.committer.core.CommitterException

Constructor.

CommitterException(String) - Constructor for exception com.norconex.committer.core.CommitterException

Constructor.

CommitterException(Throwable) - Constructor for exception com.norconex.committer.core.CommitterException

Constructor.

CommitterException(String, Throwable) - Constructor for exception com.norconex.committer.core.CommitterException

Constructor.

D

DEFAULT_COMMIT_BATCH_SIZE - Static variable in class com.norconex.committer.core.AbstractBatchCommitter

Default commit batch size.

DEFAULT_DIRECTORY - Static variable in class com.norconex.committer.core.impl.FileSystemCommitter

Default committer directory

DEFAULT_DIRECTORY - Static variable in class com.norconex.committer.core.impl.JSONFileCommitter

Default committer directory

DEFAULT_DIRECTORY - Static variable in class com.norconex.committer.core.impl.XMLFileCommitter

Default committer directory

DEFAULT_QUEUE_DIR - Static variable in class com.norconex.committer.core.AbstractFileQueueCommitter

Default directory where to queue files.

DEFAULT_QUEUE_SIZE - Static variable in class com.norconex.committer.core.AbstractCommitter

Default queue size.

delete() - Method in class com.norconex.committer.core.FileAddOperation

delete() - Method in class com.norconex.committer.core.FileDeleteOperation

delete() - Method in interface com.norconex.committer.core.ICommitOperation

Deletes the operation.

E

equals(Object) - Method in class com.norconex.committer.core.AbstractBatchCommitter

equals(Object) - Method in class com.norconex.committer.core.AbstractCommitter

equals(Object) - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

equals(Object) - Method in class com.norconex.committer.core.AbstractMappedCommitter

equals(Object) - Method in class com.norconex.committer.core.FileAddOperation

equals(Object) - Method in class com.norconex.committer.core.FileDeleteOperation

equals(Object) - Method in class com.norconex.committer.core.impl.FileSystemCommitter

equals(Object) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

equals(Object) - Method in class com.norconex.committer.core.impl.MultiCommitter

equals(Object) - Method in class com.norconex.committer.core.impl.NilCommitter

equals(Object) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

EXTENSION_CONTENT - Static variable in class com.norconex.committer.core.impl.FileSystemCommitter

EXTENSION_METADATA - Static variable in class com.norconex.committer.core.impl.FileSystemCommitter

EXTENSION_REFERENCE - Static variable in class com.norconex.committer.core.impl.FileSystemCommitter

F

FILE_SUFFIX_ADD - Static variable in class com.norconex.committer.core.impl.FileSystemCommitter

FILE_SUFFIX_REMOVE - Static variable in class com.norconex.committer.core.impl.FileSystemCommitter

FileAddOperation - Class in com.norconex.committer.core

A file-based addition operation.

FileAddOperation(File) - Constructor for class com.norconex.committer.core.FileAddOperation

Constructor.

FileDeleteOperation - Class in com.norconex.committer.core

A file-based deletion operation.

FileDeleteOperation(File) - Constructor for class com.norconex.committer.core.FileDeleteOperation

Constructor.

filesCommitting - Variable in class com.norconex.committer.core.AbstractFileQueueCommitter

Files currently being committed

FileSystemCommitter - Class in com.norconex.committer.core.impl

Commits a copy of files on the filesystem.

FileSystemCommitter() - Constructor for class com.norconex.committer.core.impl.FileSystemCommitter

G

getAddDir() - Method in class com.norconex.committer.core.impl.FileSystemCommitter

Deprecated.

since 2.0.1

getCommitBatchSize() - Method in class com.norconex.committer.core.AbstractBatchCommitter

Gets the commit batch size.

getCommitters() - Method in class com.norconex.committer.core.impl.MultiCommitter

Gets nested committers.

getContentStream() - Method in class com.norconex.committer.core.FileAddOperation

getContentStream() - Method in interface com.norconex.committer.core.IAddOperation

Gets the content as a stream

getDirectory() - Method in class com.norconex.committer.core.impl.FileSystemCommitter

Gets the directory where files are committed.

getDirectory() - Method in class com.norconex.committer.core.impl.JSONFileCommitter

Gets the directory where files are committed.

getDirectory() - Method in class com.norconex.committer.core.impl.XMLFileCommitter

Gets the directory where files are committed.

getDocsPerFile() - Method in class com.norconex.committer.core.impl.JSONFileCommitter

getDocsPerFile() - Method in class com.norconex.committer.core.impl.XMLFileCommitter

getFileNamePrefix() - Method in class com.norconex.committer.core.impl.JSONFileCommitter

Gets the file name prefix (default is null).

getFileNamePrefix() - Method in class com.norconex.committer.core.impl.XMLFileCommitter

Gets the file name prefix (default is null).

getFileNameSuffix() - Method in class com.norconex.committer.core.impl.JSONFileCommitter

Gets the file name suffix (default is null).

getFileNameSuffix() - Method in class com.norconex.committer.core.impl.XMLFileCommitter

Gets the file name suffix (default is null).

getInitialQueueDocCount() - Method in class com.norconex.committer.core.AbstractCommitter

Gets the initial document count, in case there are already documents in the queue the first time the committer is used.

getInitialQueueDocCount() - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

getMaxRetries() - Method in class com.norconex.committer.core.AbstractBatchCommitter

Gets the maximum number of retries upon batch commit failure.

getMaxRetryWait() - Method in class com.norconex.committer.core.AbstractBatchCommitter

Gets the maximum wait time before retrying a failed commit.

getMetadata() - Method in class com.norconex.committer.core.FileAddOperation

getMetadata() - Method in interface com.norconex.committer.core.IAddOperation

Gets the metadata.

getQueueDir() - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

Gets the directory where queued files are stored.

getQueueSize() - Method in class com.norconex.committer.core.AbstractCommitter

Gets the queue size.

getReference() - Method in class com.norconex.committer.core.FileAddOperation

getReference() - Method in class com.norconex.committer.core.FileDeleteOperation

getReference() - Method in interface com.norconex.committer.core.IAddOperation

Gets the document reference.

getReference() - Method in interface com.norconex.committer.core.IDeleteOperation

Gets the document reference.

getRemoveDir() - Method in class com.norconex.committer.core.impl.FileSystemCommitter

Deprecated.

since 2.0.1

getSourceContentField() - Method in class com.norconex.committer.core.AbstractMappedCommitter

Gets the source field name holding the document content.

getSourceReferenceField() - Method in class com.norconex.committer.core.AbstractMappedCommitter

Gets the source field name holding the unique identifier.

getTargetContentField() - Method in class com.norconex.committer.core.AbstractMappedCommitter

Gets the target field where to store the document content.

getTargetReferenceField() - Method in class com.norconex.committer.core.AbstractMappedCommitter

Gets the target field name to store the unique identifier.

H

hashCode() - Method in class com.norconex.committer.core.AbstractBatchCommitter

hashCode() - Method in class com.norconex.committer.core.AbstractCommitter

hashCode() - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

hashCode() - Method in class com.norconex.committer.core.AbstractMappedCommitter

hashCode() - Method in class com.norconex.committer.core.FileAddOperation

hashCode() - Method in class com.norconex.committer.core.FileDeleteOperation

hashCode() - Method in class com.norconex.committer.core.impl.FileSystemCommitter

hashCode() - Method in class com.norconex.committer.core.impl.JSONFileCommitter

hashCode() - Method in class com.norconex.committer.core.impl.MultiCommitter

hashCode() - Method in class com.norconex.committer.core.impl.NilCommitter

hashCode() - Method in class com.norconex.committer.core.impl.XMLFileCommitter

I

IAddOperation - Interface in com.norconex.committer.core

Operation representing a new or updated document to be added to the target repository.

ICommitOperation - Interface in com.norconex.committer.core

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.core

Commits documents to their final destination (e.g.

IDeleteOperation - Interface in com.norconex.committer.core

Operation representing a document to be deleted from the target repository.

isCompress() - Method in class com.norconex.committer.core.impl.JSONFileCommitter

isCompress() - Method in class com.norconex.committer.core.impl.XMLFileCommitter

isKeepSourceContentField() - Method in class com.norconex.committer.core.AbstractMappedCommitter

Whether to keep the content source field or not, once mapped.

isKeepSourceReferenceField() - Method in class com.norconex.committer.core.AbstractMappedCommitter

Whether to keep the reference source field or not, once mapped.

isPretty() - Method in class com.norconex.committer.core.impl.JSONFileCommitter

isPretty() - Method in class com.norconex.committer.core.impl.XMLFileCommitter

isSplitAddDelete() - Method in class com.norconex.committer.core.impl.JSONFileCommitter

isSplitAddDelete() - Method in class com.norconex.committer.core.impl.XMLFileCommitter

J

JSONFileCommitter - Class in com.norconex.committer.core.impl

Commits documents to JSON files.

JSONFileCommitter() - Constructor for class com.norconex.committer.core.impl.JSONFileCommitter

Constructor.

L

loadFromXML(Reader) - Method in class com.norconex.committer.core.AbstractMappedCommitter

loadFromXml(XMLConfiguration) - Method in class com.norconex.committer.core.AbstractMappedCommitter

Allows subclasses to load their config from xml

loadFromXML(Reader) - Method in class com.norconex.committer.core.impl.FileSystemCommitter

loadFromXML(Reader) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

loadFromXML(Reader) - Method in class com.norconex.committer.core.impl.MultiCommitter

loadFromXML(Reader) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

M

MultiCommitter - Class in com.norconex.committer.core.impl

This committer allows you to define user many committers as one.

MultiCommitter() - Constructor for class com.norconex.committer.core.impl.MultiCommitter

Constructor.

MultiCommitter(List<ICommitter>) - Constructor for class com.norconex.committer.core.impl.MultiCommitter

Constructor.

N

NilCommitter - Class in com.norconex.committer.core.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.core.impl.NilCommitter

Constructor.

P

prepareCommitAddition(IAddOperation) - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

Optionally performs actions on a document to be added before actually committing it.

prepareCommitAddition(IAddOperation) - Method in class com.norconex.committer.core.AbstractMappedCommitter

prepareCommitDeletion(IDeleteOperation) - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

Optionally performs operations on a document to be deleted before actually committing it.

Q

queueAddition(String, InputStream, Properties) - Method in class com.norconex.committer.core.AbstractCommitter

Queues a document to be added.

queueAddition(String, InputStream, Properties) - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

queueRemoval(String, Properties) - Method in class com.norconex.committer.core.AbstractCommitter

Queues a document to be deleted.

queueRemoval(String, Properties) - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

queueSize - Variable in class com.norconex.committer.core.AbstractCommitter

R

remove(String, Properties) - Method in class com.norconex.committer.core.AbstractCommitter

remove(String, Properties) - Method in interface com.norconex.committer.core.ICommitter

Removes a document from the target destination.

remove(String, Properties) - Method in class com.norconex.committer.core.impl.FileSystemCommitter

remove(String, Properties) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

remove(String, Properties) - Method in class com.norconex.committer.core.impl.MultiCommitter

remove(String, Properties) - Method in class com.norconex.committer.core.impl.NilCommitter

remove(String, Properties) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

removeCommitter(ICommitter...) - Method in class com.norconex.committer.core.impl.MultiCommitter

Removes one or more committers.

S

saveToXML(Writer) - Method in class com.norconex.committer.core.AbstractMappedCommitter

saveToXML(XMLStreamWriter) - Method in class com.norconex.committer.core.AbstractMappedCommitter

Allows subclasses to write their config to xml

saveToXML(Writer) - Method in class com.norconex.committer.core.impl.FileSystemCommitter

saveToXML(Writer) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

saveToXML(Writer) - Method in class com.norconex.committer.core.impl.MultiCommitter

saveToXML(Writer) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

setCommitBatchSize(int) - Method in class com.norconex.committer.core.AbstractBatchCommitter

Sets the commit batch size.

setCompress(boolean) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

setCompress(boolean) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

setDirectory(String) - Method in class com.norconex.committer.core.impl.FileSystemCommitter

Sets the directory where files are committed.

setDirectory(String) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

Sets the directory where files are committed.

setDirectory(String) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

Sets the directory where files are committed.

setDocsPerFile(int) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

setDocsPerFile(int) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

setFileNamePrefix(String) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

Sets an optional file name prefix.

setFileNamePrefix(String) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

Sets an optional file name prefix.

setFileNameSuffix(String) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

Sets an optional file name suffix.

setFileNameSuffix(String) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

Sets an optional file name suffix.

setKeepSourceContentField(boolean) - Method in class com.norconex.committer.core.AbstractMappedCommitter

Sets whether to keep the content source field or not, once mapped.

setKeepSourceReferenceField(boolean) - Method in class com.norconex.committer.core.AbstractMappedCommitter

Sets whether to keep the ID source field or not, once mapped.

setMaxRetries(int) - Method in class com.norconex.committer.core.AbstractBatchCommitter

Sets the maximum number of retries upon batch commit failure.

setMaxRetryWait(long) - Method in class com.norconex.committer.core.AbstractBatchCommitter

Sets the maximum wait time before retrying a failed commit.

setPretty(boolean) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

setPretty(boolean) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

setQueueDir(String) - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

Sets the directory where queued files are stored.

setQueueSize(int) - Method in class com.norconex.committer.core.AbstractCommitter

Sets the queue size.

setSourceContentField(String) - Method in class com.norconex.committer.core.AbstractMappedCommitter

Sets the source field name holding the document content.

setSourceReferenceField(String) - Method in class com.norconex.committer.core.AbstractMappedCommitter

sets the source field name holding the unique identifier.

setSplitAddDelete(boolean) - Method in class com.norconex.committer.core.impl.JSONFileCommitter

setSplitAddDelete(boolean) - Method in class com.norconex.committer.core.impl.XMLFileCommitter

setTargetContentField(String) - Method in class com.norconex.committer.core.AbstractMappedCommitter

Sets the target field where to store the document content.

setTargetReferenceField(String) - Method in class com.norconex.committer.core.AbstractMappedCommitter

Sets the target field name to store the unique identifier.

T

toString() - Method in class com.norconex.committer.core.AbstractBatchCommitter

toString() - Method in class com.norconex.committer.core.AbstractCommitter

toString() - Method in class com.norconex.committer.core.AbstractFileQueueCommitter

toString() - Method in class com.norconex.committer.core.AbstractMappedCommitter

toString() - Method in class com.norconex.committer.core.FileAddOperation

toString() - Method in class com.norconex.committer.core.FileDeleteOperation

toString() - Method in class com.norconex.committer.core.impl.FileSystemCommitter

toString() - Method in class com.norconex.committer.core.impl.JSONFileCommitter

toString() - Method in class com.norconex.committer.core.impl.MultiCommitter

toString() - Method in class com.norconex.committer.core.impl.NilCommitter

toString() - Method in class com.norconex.committer.core.impl.XMLFileCommitter

X

XMLFileCommitter - Class in com.norconex.committer.core.impl

Commits documents to XML files.

XMLFileCommitter() - Constructor for class com.norconex.committer.core.impl.XMLFileCommitter

Constructor.

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