Index (Norconex Committer Core 3.2.0 API)

A B C D E F G H I J L M O Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractBatchCommitter - Class in com.norconex.committer.core3.batch: A base implementation for doing batch commits.
AbstractBatchCommitter() - Constructor for class com.norconex.committer.core3.batch.AbstractBatchCommitter
AbstractCommitter - Class in com.norconex.committer.core3: A base implementation taking care of basic plumbing, such as firing main Committer events (including exceptions), storing the Committer context (available via AbstractCommitter.getCommitterContext()), and adding support for filtering unwanted requests.
AbstractCommitter() - Constructor for class com.norconex.committer.core3.AbstractCommitter
AbstractFSCommitter<T> - Class in com.norconex.committer.core3.fs: Base class for committers writing to the local file system.
AbstractFSCommitter() - Constructor for class com.norconex.committer.core3.fs.AbstractFSCommitter
accept(ICommitterRequest) - Method in class com.norconex.committer.core3.AbstractCommitter
accept(ICommitterRequest) - Method in interface com.norconex.committer.core3.ICommitter: Determines whether a request should be committed.
addRestriction(PropertyMatcher...) - Method in class com.norconex.committer.core3.AbstractCommitter: Adds one or more restrictions this committer should be restricted to.
addRestrictions(List<PropertyMatcher>) - Method in class com.norconex.committer.core3.AbstractCommitter: Adds restrictions this committer should be restricted to.
applyFieldMappings(ICommitterRequest) - Method in class com.norconex.committer.core3.AbstractCommitter: Applies configured field mappings to a request metadata.
applyTargetContent(ICommitterRequest, String) - Static method in class com.norconex.committer.core3.CommitterUtil: Applies the document content (input stream) to the target field name.
applyTargetId(ICommitterRequest, String, String) - Static method in class com.norconex.committer.core3.CommitterUtil: Applies the source ID field value after extracting it using CommitterUtil.extractSourceIdValue(ICommitterRequest, String), to the target ID ID field supplied.

B

build() - Method in class com.norconex.committer.core3.CommitterContext.Builder: Builds a context and applies defaults where needed.
build() - Method in class com.norconex.committer.core3.CommitterEvent.Builder: Builds the event instance.
builder() - Static method in class com.norconex.committer.core3.CommitterContext: Creates a builder for CommitterContext.
Builder(String, ICommitter) - Constructor for class com.norconex.committer.core3.CommitterEvent.Builder: Creates a new builder.

C

clean() - Method in class com.norconex.committer.core3.AbstractCommitter
clean() - Method in interface com.norconex.committer.core3.batch.queue.ICommitterQueue: Cleans any persisted information specific to this queue.
clean() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue
clean() - Method in interface com.norconex.committer.core3.ICommitter: Cleans any persisted information (e.g. queue) to ensure next run will start fresh.
clearFieldMappings() - Method in class com.norconex.committer.core3.AbstractCommitter: Removes all field mappings.
clearRestrictions() - Method in class com.norconex.committer.core3.AbstractCommitter: Clears all restrictions.
close() - Method in class com.norconex.committer.core3.AbstractCommitter
close() - Method in interface com.norconex.committer.core3.batch.queue.ICommitterQueue: Closes this queue and flushes remaining queued requests.
close() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue
close() - Method in interface com.norconex.committer.core3.ICommitter: Closes this committer and releases resources.
closeBatchCommitter() - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter: Subclasses can perform additional closing logic by overriding this method.
closeDocWriter(EnhancedXMLStreamWriter) - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter
closeDocWriter(Writer) - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter
closeDocWriter(CSVPrinter) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter
closeDocWriter(T) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Closes and flushes the document writer abstraction.
Column(String) - Constructor for class com.norconex.committer.core3.fs.impl.CSVFileCommitter.Column: Creates a column where header defaults to field and global truncate is used.
Column(String, int) - Constructor for class com.norconex.committer.core3.fs.impl.CSVFileCommitter.Column: Creates a column where header defaults to field.
Column(String, String) - Constructor for class com.norconex.committer.core3.fs.impl.CSVFileCommitter.Column: Creates a column with a custom header.
Column(String, String, int) - Constructor for class com.norconex.committer.core3.fs.impl.CSVFileCommitter.Column: Creates a column with full control over field, header, and truncation.
com.norconex.committer.core3 - package com.norconex.committer.core3
com.norconex.committer.core3.batch - package com.norconex.committer.core3.batch
com.norconex.committer.core3.batch.queue - package com.norconex.committer.core3.batch.queue
com.norconex.committer.core3.batch.queue.impl - package com.norconex.committer.core3.batch.queue.impl
com.norconex.committer.core3.fs - package com.norconex.committer.core3.fs
com.norconex.committer.core3.fs.impl - package com.norconex.committer.core3.fs.impl
com.norconex.committer.core3.impl - package com.norconex.committer.core3.impl
commitBatch(Iterator<ICommitterRequest>) - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter: Commits a batch of queued requests.
COMMITTER_ACCEPT_ERROR - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer acceptance check produced an error.
COMMITTER_ACCEPT_NO - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer has rejected a request and it will not commit it.
COMMITTER_ACCEPT_YES - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer has accepted a request and it will commit it.
COMMITTER_BATCH_BEGIN - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer is about to commit a request batch.
COMMITTER_BATCH_END - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer is done committing a request batch Triggered by supporting Committers only.
COMMITTER_BATCH_ERROR - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer encountered an error when committing a request batch.
COMMITTER_CLEAN_BEGIN - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer is being cleaned.
COMMITTER_CLEAN_END - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer has been cleaned.
COMMITTER_CLEAN_ERROR - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer encountered an error when cleaning.
COMMITTER_CLOSE_BEGIN - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer is closing.
COMMITTER_CLOSE_END - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer is closed.
COMMITTER_CLOSE_ERROR - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer encountered an error when closing.
COMMITTER_DELETE_BEGIN - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer is receiving document to be removed.
COMMITTER_DELETE_END - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer has received a document to be removed.
COMMITTER_DELETE_ERROR - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer entity removal produced an error.
COMMITTER_INIT_BEGIN - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer began its initialization.
COMMITTER_INIT_END - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer has been initialized.
COMMITTER_INIT_ERROR - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer encountered an error when initializing.
COMMITTER_UPSERT_BEGIN - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer is receiving a document to be updated or inserted.
COMMITTER_UPSERT_END - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer has received a document to be updated or inserted.
COMMITTER_UPSERT_ERROR - Static variable in class com.norconex.committer.core3.CommitterEvent: The Committer entity update/upsert produced an error.
CommitterContext - Class in com.norconex.committer.core3: Holds data defined outside a committer but useful or required for the committer execution.
CommitterContext.Builder - Class in com.norconex.committer.core3: Builder for CommitterContext.
CommitterEvent - Class in com.norconex.committer.core3: Default committer events.
CommitterEvent(CommitterEvent.Builder) - Constructor for class com.norconex.committer.core3.CommitterEvent: New event.
CommitterEvent.Builder - Class in com.norconex.committer.core3: Builder for CommitterEvent.
CommitterException - Exception Class in com.norconex.committer.core3: Triggered when something went wrong with committing.
CommitterException() - Constructor for exception class com.norconex.committer.core3.CommitterException: Constructor.
CommitterException(String) - Constructor for exception class com.norconex.committer.core3.CommitterException: Constructor.
CommitterException(String, Throwable) - Constructor for exception class com.norconex.committer.core3.CommitterException: Constructor.
CommitterException(Throwable) - Constructor for exception class com.norconex.committer.core3.CommitterException: Constructor.
CommitterQueueException - Exception Class in com.norconex.committer.core3.batch.queue: Triggered when something went wrong with the committer queue.
CommitterQueueException() - Constructor for exception class com.norconex.committer.core3.batch.queue.CommitterQueueException: Constructor.
CommitterQueueException(String) - Constructor for exception class com.norconex.committer.core3.batch.queue.CommitterQueueException: Constructor.
CommitterQueueException(String, Throwable) - Constructor for exception class com.norconex.committer.core3.batch.queue.CommitterQueueException: Constructor.
CommitterQueueException(Throwable) - Constructor for exception class com.norconex.committer.core3.batch.queue.CommitterQueueException: Constructor.
committerRequest(ICommitterRequest) - Method in class com.norconex.committer.core3.CommitterEvent.Builder: Attaches the committer request associated with this event.
CommitterUtil - Class in com.norconex.committer.core3: Committer-related utility methods.
consume(Iterator<ICommitterRequest>) - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
consume(Iterator<ICommitterRequest>) - Method in interface com.norconex.committer.core3.batch.IBatchConsumer: Consumes a batch of committer requests.
Content handling - Search tag in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Section
createDocWriter(Writer) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Creates a document writer wrapping the provided character writer.
createDocWriter(Writer) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter
createDocWriter(Writer) - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter
createDocWriter(Writer) - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter
CSVFileCommitter - Class in com.norconex.committer.core3.fs.impl: Commits documents to CSV files (Comma Separated Value).
CSVFileCommitter() - Constructor for class com.norconex.committer.core3.fs.impl.CSVFileCommitter
CSVFileCommitter.Column - Class in com.norconex.committer.core3.fs.impl: Column mapping definition for generated CSV files.
CSV Format - Search tag in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Section

D

DEFAULT_BATCH_SIZE - Static variable in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Default number of requests per batch.
DEFAULT_MAX_PER_FOLDER - Static variable in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Default maximum number of entries per queue sub-folder.
DEFAULT_TRUNCATE_AT - Static variable in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Default truncate length for column values.
delete(DeleteRequest) - Method in class com.norconex.committer.core3.AbstractCommitter
delete(DeleteRequest) - Method in interface com.norconex.committer.core3.ICommitter: Deletes a document from the target repository.
DeleteRequest - Class in com.norconex.committer.core3: A committer deletion request.
DeleteRequest(String, Properties) - Constructor for class com.norconex.committer.core3.DeleteRequest: Creates a deletion request.
doClean() - Method in class com.norconex.committer.core3.AbstractCommitter: Performs concrete clean-up of persisted committer state.
doClean() - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
doClean() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter
doClean() - Method in class com.norconex.committer.core3.impl.LogCommitter
doClean() - Method in class com.norconex.committer.core3.impl.MemoryCommitter
doClose() - Method in class com.norconex.committer.core3.AbstractCommitter: Subclasses can perform additional closing logic by overriding this method.
doClose() - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
doClose() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter
doClose() - Method in class com.norconex.committer.core3.impl.LogCommitter
doClose() - Method in class com.norconex.committer.core3.impl.MemoryCommitter
doDelete(DeleteRequest) - Method in class com.norconex.committer.core3.AbstractCommitter: Performs the concrete delete operation.
doDelete(DeleteRequest) - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
doDelete(DeleteRequest) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter
doDelete(DeleteRequest) - Method in class com.norconex.committer.core3.impl.LogCommitter
doDelete(DeleteRequest) - Method in class com.norconex.committer.core3.impl.MemoryCommitter
doInit() - Method in class com.norconex.committer.core3.AbstractCommitter: Subclasses can perform additional initialization by overriding this method.
doInit() - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
doInit() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter
doInit() - Method in class com.norconex.committer.core3.impl.LogCommitter
doInit() - Method in class com.norconex.committer.core3.impl.MemoryCommitter
doUpsert(UpsertRequest) - Method in class com.norconex.committer.core3.AbstractCommitter: Performs the concrete upsert operation.
doUpsert(UpsertRequest) - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
doUpsert(UpsertRequest) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter
doUpsert(UpsertRequest) - Method in class com.norconex.committer.core3.impl.LogCommitter
doUpsert(UpsertRequest) - Method in class com.norconex.committer.core3.impl.MemoryCommitter

E

equals(Object) - Method in class com.norconex.committer.core3.AbstractCommitter
equals(Object) - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
equals(Object) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue
equals(Object) - Method in class com.norconex.committer.core3.CommitterContext
equals(Object) - Method in class com.norconex.committer.core3.CommitterEvent
equals(Object) - Method in class com.norconex.committer.core3.DeleteRequest
equals(Object) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter
equals(Object) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter.Column
equals(Object) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter
equals(Object) - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter
equals(Object) - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter
equals(Object) - Method in class com.norconex.committer.core3.impl.LogCommitter
equals(Object) - Method in class com.norconex.committer.core3.impl.MemoryCommitter
equals(Object) - Method in class com.norconex.committer.core3.UpsertRequest
extractSourceIdValue(ICommitterRequest, String) - Static method in class com.norconex.committer.core3.CommitterUtil: Extracts the source ID value.
extractSourceIdValue(ICommitterRequest, String, boolean) - Static method in class com.norconex.committer.core3.CommitterUtil: Extracts the source ID value.

F

findZipFiles(Path) - Static method in class com.norconex.committer.core3.batch.queue.impl.FSQueueUtil: Finds all files with the ".zip" extension from within a given directory, recursively.
fireDebug(String) - Method in class com.norconex.committer.core3.AbstractCommitter: Fires a debug-level event not tied to a specific request.
fireDebug(String, ICommitterRequest) - Method in class com.norconex.committer.core3.AbstractCommitter: Fires a debug-level event for a given request.
fireError(String, ICommitterRequest, Exception) - Method in class com.norconex.committer.core3.AbstractCommitter: Fires an error-level event for a given request.
fireError(String, Exception) - Method in class com.norconex.committer.core3.AbstractCommitter: Fires an error-level event not tied to a specific request.
fireInfo(String) - Method in class com.norconex.committer.core3.AbstractCommitter: Fires an info-level event not tied to a specific request.
fireInfo(String, ICommitterRequest) - Method in class com.norconex.committer.core3.AbstractCommitter: Fires an info-level event for a given request.
fromZipFile(Path) - Static method in class com.norconex.committer.core3.batch.queue.impl.FSQueueUtil: Deserializes a request from a queue zip file.
fromZipFile(Path, CachedStreamFactory) - Static method in class com.norconex.committer.core3.batch.queue.impl.FSQueueUtil: Deserializes a request from a queue zip file.
FSQueue - Class in com.norconex.committer.core3.batch.queue.impl: File System queue.
FSQueue() - Constructor for class com.norconex.committer.core3.batch.queue.impl.FSQueue
FSQueue.SplitBatch - Enum Class in com.norconex.committer.core3.batch.queue.impl: Batch splitting strategy when a batch commit fails.
FSQueueUtil - Class in com.norconex.committer.core3.batch.queue.impl: File sytem queue utility methods.

G

Generated JSON format: - Search tag in class com.norconex.committer.core3.fs.impl.JSONFileCommitter: Section
Generated XML format: - Search tag in class com.norconex.committer.core3.fs.impl.XMLFileCommitter: Section
getAllRequests() - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Gets all stored requests.
getBatchConsumer() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Gets the currently configured batch consumer.
getBatchSize() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Gets the number of documents to be queued in a batch on disk before consuming that batch.
getColumns() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Gets configured CSV columns.
getCommitterContext() - Method in class com.norconex.committer.core3.AbstractCommitter: Gets the current committer context.
getCommitterQueue() - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter: Gets the queue used to persist and consume commit requests.
getContent() - Method in class com.norconex.committer.core3.UpsertRequest: Gets request content stream.
getContentAsString(ICommitterRequest) - Static method in class com.norconex.committer.core3.CommitterUtil: Gets the request content as a string.
getDeleteCount() - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Gets number of delete requests committed in this instance.
getDeleteRequests() - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Gets stored delete requests.
getDelimiter() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Gets the CSV delimiter character.
getDirectory() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Gets the directory where files are committed.
getDocsPerFile() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Gets the maximum number of documents written per output file.
getEscape() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Gets the CSV escape character.
getEventManager() - Method in class com.norconex.committer.core3.CommitterContext: Gets the event manager used to fire committer events.
getField() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter.Column: Gets the source field name.
getFieldMappings() - Method in class com.norconex.committer.core3.AbstractCommitter: Gets an unmodifiable copy of the metadata mappings.
getFieldMatcher() - Method in class com.norconex.committer.core3.impl.LogCommitter: Gets the metadata field matcher used to select logged metadata fields.
getFieldMatcher() - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Gets the metadata field matcher used to keep request metadata.
getFileExtension() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Gets the output file extension (without leading dot).
getFileExtension() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter
getFileExtension() - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter
getFileExtension() - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter
getFileNamePrefix() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Gets the file name prefix (default is null).
getFileNameSuffix() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Gets the file name suffix (default is null).
getFormat() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Gets the preset CSV format name.
getHeader() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter.Column: Gets the output header name.
getIndent() - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter: Gets JSON indentation level.
getIndent() - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter: Gets XML indentation level.
getLogLevel() - Method in class com.norconex.committer.core3.impl.LogCommitter: Gets output log level.
getMaxPerFolder() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Gets the maximum number of files to be queued on disk in a given folders.
getMaxRetries() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Gets the maximum number of retries on batch commit failure.
getMetadata() - Method in class com.norconex.committer.core3.DeleteRequest
getMetadata() - Method in interface com.norconex.committer.core3.ICommitterRequest: Gets the metadata.
getMetadata() - Method in class com.norconex.committer.core3.UpsertRequest
getMultiValueJoinDelimiter() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Gets the delimiter used to join multi-valued metadata.
getQuote() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Gets the CSV quote character.
getReference() - Method in class com.norconex.committer.core3.DeleteRequest
getReference() - Method in interface com.norconex.committer.core3.ICommitterRequest: Gets the document reference.
getReference() - Method in class com.norconex.committer.core3.UpsertRequest
getRequest() - Method in class com.norconex.committer.core3.CommitterEvent: Gets the request associated with this event.
getRequestCount() - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Gets total number of requests held in memory.
getRestrictions() - Method in class com.norconex.committer.core3.AbstractCommitter: Gets all restrictions
getRetryDelay() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Gets the delay between retry attempts in milliseconds.
getSplitBatch() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Gets the strategy used to split failing batches.
getStreamFactory() - Method in class com.norconex.committer.core3.CommitterContext: Gets the cached stream factory used by committers.
getTruncateAt() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter.Column: Gets the truncate length override for this column.
getTruncateAt() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Gets the global truncate length for values.
getTypeHeader() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Gets the header name used for commit request type.
getUpsertCount() - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Gets number of upsert requests committed in this instance.
getUpsertRequests() - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Gets stored upsert requests.
getWorkDir() - Method in class com.norconex.committer.core3.CommitterContext: Gets a unique working directory for a committer (if one is needed).

H

HALF - Enum constant in enum class com.norconex.committer.core3.batch.queue.impl.FSQueue.SplitBatch: Split failing batches in half on each failure cycle.
Handling Failures - Search tag in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Section
hashCode() - Method in class com.norconex.committer.core3.AbstractCommitter
hashCode() - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
hashCode() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue
hashCode() - Method in class com.norconex.committer.core3.CommitterContext
hashCode() - Method in class com.norconex.committer.core3.CommitterEvent
hashCode() - Method in class com.norconex.committer.core3.DeleteRequest
hashCode() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter
hashCode() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter.Column
hashCode() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter
hashCode() - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter
hashCode() - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter
hashCode() - Method in class com.norconex.committer.core3.impl.LogCommitter
hashCode() - Method in class com.norconex.committer.core3.impl.MemoryCommitter
hashCode() - Method in class com.norconex.committer.core3.UpsertRequest

I

IBatchConsumer - Interface in com.norconex.committer.core3.batch: Functional interface for processing requests in batch (for committers supporting it).
ICommitter - Interface in com.norconex.committer.core3: Commits documents to their final destination (e.g. search engine).
ICommitterQueue - Interface in com.norconex.committer.core3.batch.queue: A committer queue, accumulating requests before they are committed in one or multiple batches.
ICommitterRequest - Interface in com.norconex.committer.core3: A document (or record, entry, entity, etc.) to be committed.
init(CommitterContext) - Method in class com.norconex.committer.core3.AbstractCommitter
init(CommitterContext) - Method in interface com.norconex.committer.core3.ICommitter: Initializes this committer with execution context.
init(CommitterContext, IBatchConsumer) - Method in interface com.norconex.committer.core3.batch.queue.ICommitterQueue: Initializes this queue.
init(CommitterContext, IBatchConsumer) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Initializes this file-system queue.
initBatchCommitter() - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter: Subclasses can perform additional initialization by overriding this method.
isCommitLeftoversOnInit() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Whether leftover batches are committed during initialization.
isCompress() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Whether output files are gzip-compressed.
isEmpty(Path) - Static method in class com.norconex.committer.core3.batch.queue.impl.FSQueueUtil: Recursively gets whether a queue directory is empty of queue files.
isIgnoreContent() - Method in class com.norconex.committer.core3.impl.LogCommitter: Whether document content is omitted from logs.
isIgnoreContent() - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Whether request content is ignored when storing requests in memory.
isIgnoreErrors() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Whether commit errors should be logged and ignored.
isShowHeaders() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Whether a header row is written.
isSplitUpsertDelete() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Whether upsert and delete requests are written to separate files.

J

JSONFileCommitter - Class in com.norconex.committer.core3.fs.impl: Commits documents to JSON files.
JSONFileCommitter() - Constructor for class com.norconex.committer.core3.fs.impl.JSONFileCommitter

L

loadBatchCommitterFromXML(XML) - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter: Loads batch-committer-specific configuration from XML.
loadCommitterFromXML(XML) - Method in class com.norconex.committer.core3.AbstractCommitter: Loads committer-specific configuration.
loadCommitterFromXML(XML) - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
loadCommitterFromXML(XML) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter
loadCommitterFromXML(XML) - Method in class com.norconex.committer.core3.impl.LogCommitter
loadCommitterFromXML(XML) - Method in class com.norconex.committer.core3.impl.MemoryCommitter
loadFromXML(XML) - Method in class com.norconex.committer.core3.AbstractCommitter
loadFromXML(XML) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue
loadFSCommitterFromXML(XML) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Loads file-system-committer-specific settings from XML.
loadFSCommitterFromXML(XML) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter
loadFSCommitterFromXML(XML) - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter
loadFSCommitterFromXML(XML) - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter
LogCommitter - Class in com.norconex.committer.core3.impl: WARNING: Not intended for production use.
LogCommitter() - Constructor for class com.norconex.committer.core3.impl.LogCommitter

M

MemoryCommitter - Class in com.norconex.committer.core3.impl: WARNING: Not intended for production use.
MemoryCommitter() - Constructor for class com.norconex.committer.core3.impl.MemoryCommitter: Constructor.

O

OFF - Enum constant in enum class com.norconex.committer.core3.batch.queue.impl.FSQueue.SplitBatch: Do not split failing batches.
ONE - Enum constant in enum class com.norconex.committer.core3.batch.queue.impl.FSQueue.SplitBatch: Split failing batches down to one request at a time.

Q

queue(ICommitterRequest) - Method in interface com.norconex.committer.core3.batch.queue.ICommitterQueue: Queues a single request for later batch processing.
queue(ICommitterRequest) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Queues a request on disk and triggers batch consumption when needed.

R

removeFieldMapping(String) - Method in class com.norconex.committer.core3.AbstractCommitter: Removes a field mapping by source field name.
removeRequest(ICommitterRequest) - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Removes a stored request from memory.
removeRestriction(PropertyMatcher) - Method in class com.norconex.committer.core3.AbstractCommitter: Removes a restriction.
removeRestriction(String) - Method in class com.norconex.committer.core3.AbstractCommitter: Removes all restrictions on a given field.

S

saveBatchCommitterToXML(XML) - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter: Saves batch-committer-specific configuration to XML.
saveCommitterToXML(XML) - Method in class com.norconex.committer.core3.AbstractCommitter: Saves committer-specific configuration.
saveCommitterToXML(XML) - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
saveCommitterToXML(XML) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter
saveCommitterToXML(XML) - Method in class com.norconex.committer.core3.impl.LogCommitter
saveCommitterToXML(XML) - Method in class com.norconex.committer.core3.impl.MemoryCommitter
saveFSCommitterToXML(XML) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Saves file-system-committer-specific settings to XML.
saveFSCommitterToXML(XML) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter
saveFSCommitterToXML(XML) - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter
saveFSCommitterToXML(XML) - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter
saveToXML(XML) - Method in class com.norconex.committer.core3.AbstractCommitter
saveToXML(XML) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue
setBatchSize(int) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Sets the number of documents to be queued in a batch on disk before consuming that batch.
setColumns(CSVFileCommitter.Column...) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Replaces configured columns.
setColumns(List<CSVFileCommitter.Column>) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Replaces configured columns.
setCommitLeftoversOnInit(boolean) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Sets whether leftover batches are committed during initialization.
setCommitterQueue(ICommitterQueue) - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter: Sets the queue used to persist and consume commit requests.
setCompress(boolean) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Enables or disables gzip compression of output files.
setDelimiter(Character) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Sets the CSV delimiter character.
setDirectory(Path) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Sets the directory where files are committed.
setDocsPerFile(int) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Sets the maximum number of documents written per output file.
setEscape(Character) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Sets the CSV escape character.
setEventManager(EventManager) - Method in class com.norconex.committer.core3.CommitterContext.Builder: Sets the context event manager.
setFieldMapping(String, String) - Method in class com.norconex.committer.core3.AbstractCommitter: Sets a metadata field mapping.
setFieldMappings(Map<String, String>) - Method in class com.norconex.committer.core3.AbstractCommitter: Sets a metadata field mappings, where the key is the source field and the value is the target field.
setFieldMatcher(TextMatcher) - Method in class com.norconex.committer.core3.impl.LogCommitter: Sets the metadata field matcher used to select logged metadata fields.
setFieldMatcher(TextMatcher) - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Sets the metadata field matcher used to keep request metadata.
setFileNamePrefix(String) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Sets an optional file name prefix.
setFileNameSuffix(String) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Sets an optional file name suffix.
setFormat(String) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Sets the preset CSV format name.
setIgnoreContent(boolean) - Method in class com.norconex.committer.core3.impl.LogCommitter: Sets whether document content should be omitted from logs.
setIgnoreContent(boolean) - Method in class com.norconex.committer.core3.impl.MemoryCommitter: Sets whether request content is ignored when storing requests in memory.
setIgnoreErrors(boolean) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Sets whether commit errors should be logged and ignored.
setIndent(int) - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter: Sets JSON indentation level.
setIndent(int) - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter: Sets XML indentation level.
setLogLevel(String) - Method in class com.norconex.committer.core3.impl.LogCommitter: Sets output log level.
setMaxPerFolder(int) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Sets the maximum number of files to be queued on disk in a given folders.
setMaxRetries(int) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Sets the maximum number of retries on batch commit failure.
setMultiValueJoinDelimiter(String) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Sets the delimiter used to join multi-valued metadata.
setQuote(Character) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Sets the CSV quote character.
setRetryDelay(long) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Sets the delay between retry attempts in milliseconds.
setShowHeaders(boolean) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Sets whether a header row is written.
setSplitBatch(FSQueue.SplitBatch) - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue: Sets the strategy used to split failing batches.
setSplitUpsertDelete(boolean) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Sets whether upserts and deletes should be written to separate files.
setStreamFactory(CachedStreamFactory) - Method in class com.norconex.committer.core3.CommitterContext.Builder: Sets the cached stream factory.
setTruncateAt(int) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Sets the global truncate length for values.
setTypeHeader(String) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Sets the header name used for commit request type.
setWorkDir(Path) - Method in class com.norconex.committer.core3.CommitterContext.Builder: Sets the context working directory.

T

toString() - Method in class com.norconex.committer.core3.AbstractCommitter
toString() - Method in class com.norconex.committer.core3.batch.AbstractBatchCommitter
toString() - Method in class com.norconex.committer.core3.batch.queue.impl.FSQueue
toString() - Method in class com.norconex.committer.core3.CommitterContext
toString() - Method in class com.norconex.committer.core3.CommitterEvent
toString() - Method in class com.norconex.committer.core3.DeleteRequest
toString() - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter
toString() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter.Column
toString() - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter
toString() - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter
toString() - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter
toString() - Method in class com.norconex.committer.core3.impl.LogCommitter
toString() - Method in class com.norconex.committer.core3.impl.MemoryCommitter
toString() - Method in class com.norconex.committer.core3.UpsertRequest
toZipFile(ICommitterRequest, Path) - Static method in class com.norconex.committer.core3.batch.queue.impl.FSQueueUtil: Serializes a request to a queue zip file.
Truncate long values - Search tag in class com.norconex.committer.core3.fs.impl.CSVFileCommitter: Section

U

upsert(UpsertRequest) - Method in class com.norconex.committer.core3.AbstractCommitter
upsert(UpsertRequest) - Method in interface com.norconex.committer.core3.ICommitter: Creates or updates a document in the target repository.
UpsertRequest - Class in com.norconex.committer.core3: A committer upsert request (update or insert).
UpsertRequest(String, Properties, InputStream) - Constructor for class com.norconex.committer.core3.UpsertRequest: Creates an upsert request.

V

valueOf(String) - Static method in enum class com.norconex.committer.core3.batch.queue.impl.FSQueue.SplitBatch: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.norconex.committer.core3.batch.queue.impl.FSQueue.SplitBatch: Returns an array containing the constants of this enum class, in the order they are declared.

W

withEventManager(EventManager) - Method in class com.norconex.committer.core3.CommitterContext: Creates a copy of this context with a different event manager.
withStreamFactory(CachedStreamFactory) - Method in class com.norconex.committer.core3.CommitterContext: Creates a copy of this context with a different stream factory.
withWorkdir(Path) - Method in class com.norconex.committer.core3.CommitterContext: Creates a copy of this context with a different working directory.
writeDelete(EnhancedXMLStreamWriter, DeleteRequest) - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter
writeDelete(Writer, DeleteRequest) - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter
writeDelete(CSVPrinter, DeleteRequest) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter
writeDelete(T, DeleteRequest) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Writes a delete request to the current output writer.
writeUpsert(EnhancedXMLStreamWriter, UpsertRequest) - Method in class com.norconex.committer.core3.fs.impl.XMLFileCommitter
writeUpsert(Writer, UpsertRequest) - Method in class com.norconex.committer.core3.fs.impl.JSONFileCommitter
writeUpsert(CSVPrinter, UpsertRequest) - Method in class com.norconex.committer.core3.fs.impl.CSVFileCommitter
writeUpsert(T, UpsertRequest) - Method in class com.norconex.committer.core3.fs.AbstractFSCommitter: Writes an upsert request to the current output writer.

X

XML configuration usage: - Search tag in class com.norconex.committer.core3.fs.AbstractFSCommitter: Section
XMLFileCommitter - Class in com.norconex.committer.core3.fs.impl: Commits documents to XML files.
XMLFileCommitter() - Constructor for class com.norconex.committer.core3.fs.impl.XMLFileCommitter

A B C D E F G H I J L M O Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form