com.norconex.committer.core3.fs

Class AbstractFSCommitter<T>

java.lang.Object

com.norconex.committer.core3.AbstractCommitter

com.norconex.committer.core3.fs.AbstractFSCommitter<T>

Type Parameters:

T - type of file serializer

All Implemented Interfaces:

ICommitter, IXMLConfigurable, AutoCloseable

Direct Known Subclasses:

CSVFileCommitter, JSONFileCommitter, XMLFileCommitter

public abstract class AbstractFSCommitter<T>
extends AbstractCommitter
implements IXMLConfigurable

Base class for committers writing to the local file system.

XML configuration usage:

The following are configuration options inherited by subclasses:

<directory>(path where to save the files)</directory>
<docsPerFile>(max number of docs per file)</docsPerFile>
<compress>[false|true]</compress>
<splitUpsertDelete>[false|true]</splitUpsertDelete>
<fileNamePrefix>(optional prefix to created file names)</fileNamePrefix>
<fileNameSuffix>(optional suffix to created file names)</fileNameSuffix>
<!-- multiple "restrictTo" tags allowed (only one needs to match) -->
<restrictTo>
  <fieldMatcher
      method="[basic|csv|wildcard|regex]"
      ignoreCase="[false|true]"
      ignoreDiacritic="[false|true]"
      partial="[false|true]">
    (field-matching expression)
  </fieldMatcher>
  <valueMatcher
      method="[basic|csv|wildcard|regex]"
      ignoreCase="[false|true]"
      ignoreDiacritic="[false|true]"
      partial="[false|true]">
    (value-matching expression)
  </valueMatcher>
</restrictTo>
<fieldMappings>
  <!-- Add as many field mappings as needed -->
  <mapping
      fromField="(source field name)"
      toField="(target field name)"/>
</fieldMappings>

Since:

3.0.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
AbstractFSCommitter()

Method Summary

Modifier and Type	Method and Description
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 other)
Path	getDirectory() Gets the directory where files are committed.
int	getDocsPerFile()
protected abstract String	getFileExtension()
String	getFileNamePrefix() Gets the file name prefix (default is null).
String	getFileNameSuffix() Gets the file name suffix (default is null).
int	hashCode()
boolean	isCompress()
boolean	isSplitUpsertDelete()
void	loadCommitterFromXML(XML xml)
void	loadFSCommitterFromXML(XML xml)
void	saveCommitterToXML(XML xml)
void	saveFSCommitterToXML(XML xml)
void	setCompress(boolean compress)
void	setDirectory(Path directory)
void	setDocsPerFile(int docsPerFile)
void	setFileNamePrefix(String fileNamePrefix) Sets an optional file name prefix.
void	setFileNameSuffix(String fileNameSuffix) Sets an optional file name suffix.
void	setSplitUpsertDelete(boolean separateAddDelete)
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.core3.AbstractCommitter

accept, addRestriction, addRestrictions, applyFieldMappings, clean, clearFieldMappings, clearRestrictions, close, delete, fireDebug, fireDebug, fireError, fireError, fireInfo, fireInfo, getCommitterContext, getFieldMappings, getRestrictions, init, loadFromXML, removeFieldMapping, removeRestriction, removeRestriction, saveToXML, setFieldMapping, setFieldMappings, upsert

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.norconex.commons.lang.xml.IXMLConfigurable

loadFromXML, saveToXML

Constructor Detail

AbstractFSCommitter

public AbstractFSCommitter()

Method Detail

getDirectory

public Path getDirectory()

Gets the directory where files are committed.

Returns:

directory

setDirectory

public void setDirectory(Path directory)

getDocsPerFile

public int getDocsPerFile()

setDocsPerFile

public void setDocsPerFile(int docsPerFile)

isCompress

public boolean isCompress()

setCompress

public void setCompress(boolean compress)

isSplitUpsertDelete

public boolean isSplitUpsertDelete()

setSplitUpsertDelete

public void setSplitUpsertDelete(boolean separateAddDelete)

getFileNamePrefix

public String getFileNamePrefix()

Gets the file name prefix (default is null).

Returns:

file name prefix

setFileNamePrefix

public void setFileNamePrefix(String fileNamePrefix)

Sets an optional file name prefix.

Parameters:

fileNamePrefix - file name prefix

getFileNameSuffix

public String getFileNameSuffix()

Gets the file name suffix (default is null).

Returns:

file name suffix

setFileNameSuffix

public void setFileNameSuffix(String fileNameSuffix)

Sets an optional file name suffix.

Parameters:

fileNameSuffix - file name suffix

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

Throws:

CommitterException - error initializing

doUpsert

protected void doUpsert(UpsertRequest upsertRequest)
                 throws CommitterException

Specified by:

doUpsert in class AbstractCommitter

Throws:

CommitterException

doDelete

protected void doDelete(DeleteRequest deleteRequest)
                 throws CommitterException

Specified by:

doDelete in class AbstractCommitter

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

Throws:

CommitterException - error closing committer

doClean

protected void doClean()
                throws CommitterException

Specified by:

doClean in class AbstractCommitter

Throws:

CommitterException

loadCommitterFromXML

public final void loadCommitterFromXML(XML xml)

Specified by:

loadCommitterFromXML in class AbstractCommitter

saveCommitterToXML

public final void saveCommitterToXML(XML xml)

Specified by:

saveCommitterToXML in class AbstractCommitter

loadFSCommitterFromXML

public void loadFSCommitterFromXML(XML xml)

saveFSCommitterToXML

public void saveFSCommitterToXML(XML xml)

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 other)

Overrides:

equals in class AbstractCommitter

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCommitter

toString

public String toString()

Overrides:

toString in class AbstractCommitter