Package com.norconex.committer.core.fs

Class AbstractFsCommitter<T,C extends BaseFsCommitterConfig>

java.lang.Object

com.norconex.committer.core.AbstractCommitter<C>

com.norconex.committer.core.fs.AbstractFsCommitter<T,C>

Type Parameters:

T - type of file serializer

C - type of configuration object

All Implemented Interfaces:

Committer, Configurable<C>, AutoCloseable

Direct Known Subclasses:

CsvFileCommitter, JsonFileCommitter, XmlFileCommitter

public abstract class AbstractFsCommitter<T,C extends BaseFsCommitterConfig>
extends AbstractCommitter<C>

Base class for Committers writing to the local file system.

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractFsCommitter()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
protected abstract void	closeDocWriter(T docWriter)
protected abstract T	createDocWriter(Writer writer)
protected void	doClean()
protected void	doClose()	Subclasses can perform additional closing logic by overriding this method.
protected void	doDelete(DeleteRequest deleteRequest)
protected void	doInit()	Subclasses can perform additional initialization by overriding this method.
protected void	doUpsert(UpsertRequest upsertRequest)
boolean	equals(Object o)
protected abstract String	getFileExtension()
Path	getResolvedDirectory()	The directly from configuration, else, from the committer context working directory.
int	hashCode()
String	toString()
protected abstract void	writeDelete(T docWriter, DeleteRequest deleteRequest)
protected abstract void	writeUpsert(T docWriter, UpsertRequest upsertRequest)

Methods inherited from class com.norconex.committer.core.AbstractCommitter

accept, applyFieldMappings, clean, close, delete, fireDebug, fireDebug, fireError, fireError, fireInfo, fireInfo, getCommitterContext, init, upsert

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.norconex.commons.lang.config.Configurable

getConfiguration

Constructor Details

AbstractFsCommitter

public AbstractFsCommitter()

Method Details

doInit

protected void doInit()
               throws CommitterException

Description copied from class: AbstractCommitter

Subclasses can perform additional initialization by overriding this method. Default implementation does nothing. The CommitterContext will be initialized when invoking AbstractCommitter.getCommitterContext()

Specified by:

doInit in class AbstractCommitter<C extends BaseFsCommitterConfig>

Throws:

CommitterException - error initializing

doUpsert

protected void doUpsert(UpsertRequest upsertRequest)
                 throws CommitterException

Specified by:

doUpsert in class AbstractCommitter<C extends BaseFsCommitterConfig>

Throws:

CommitterException

doDelete

protected void doDelete(DeleteRequest deleteRequest)
                 throws CommitterException

Specified by:

doDelete in class AbstractCommitter<C extends BaseFsCommitterConfig>

Throws:

CommitterException

doClose

protected void doClose()
                throws CommitterException

Description copied from class: AbstractCommitter

Subclasses can perform additional closing logic by overriding this method. Default implementation does nothing.

Specified by:

doClose in class AbstractCommitter<C extends BaseFsCommitterConfig>

Throws:

CommitterException - error closing committer

doClean

protected void doClean()
                throws CommitterException

Specified by:

doClean in class AbstractCommitter<C extends BaseFsCommitterConfig>

Throws:

CommitterException

getFileExtension

protected abstract String getFileExtension()

createDocWriter

protected abstract T createDocWriter(Writer writer)
                              throws IOException

Throws:

IOException

writeUpsert

protected abstract void writeUpsert(T docWriter,
 UpsertRequest upsertRequest)
                             throws IOException

Throws:

IOException

writeDelete

protected abstract void writeDelete(T docWriter,
 DeleteRequest deleteRequest)
                             throws IOException

Throws:

IOException

closeDocWriter

protected abstract void closeDocWriter(T docWriter)
                                throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractCommitter<C extends BaseFsCommitterConfig>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractCommitter<C extends BaseFsCommitterConfig>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCommitter<C extends BaseFsCommitterConfig>

toString

public String toString()

Overrides:

toString in class AbstractCommitter<C extends BaseFsCommitterConfig>

getResolvedDirectory

public Path getResolvedDirectory()

The directly from configuration, else, from the committer context working directory.