com.norconex.committer.core3.impl

Class LogCommitter

java.lang.Object

com.norconex.committer.core3.AbstractCommitter

com.norconex.committer.core3.impl.LogCommitter

All Implemented Interfaces:

ICommitter, IXMLConfigurable, AutoCloseable

public class LogCommitter
extends AbstractCommitter
implements IXMLConfigurable

WARNING: Not intended for production use.

A Committer that logs all data associated with every document, added or removed, to the application logs, or the console (STDOUT/STDERR). Default uses application logger with INFO log level.

This Committer can be useful for troubleshooting. Given how much information this could represent, it is recommended you do not use in a production environment. At a minimum, if you are logging to file, make sure to rotate/clean the logs regularly.

XML configuration usage:

<committer
    class="com.norconex.committer.core3.impl.LogCommitter">
  <logLevel>[TRACE|DEBUG|INFO|WARN|ERROR|STDOUT|STDERR]</logLevel>
  <fieldMatcher
      method="[basic|csv|wildcard|regex]"
      ignoreCase="[false|true]"
      ignoreDiacritic="[false|true]"
      partial="[false|true]">
    (Expression matching fields to log. Default logs all.)
  </fieldMatcher>
  <ignoreContent>[false|true]</ignoreContent>
  <!-- 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>
</committer>

Since:

3.0.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
LogCommitter()

Method Summary

Modifier and Type	Method and Description
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)
TextMatcher	getFieldMatcher()
String	getLogLevel()
int	hashCode()
boolean	isIgnoreContent()
void	loadCommitterFromXML(XML xml)
void	saveCommitterToXML(XML xml)
void	setFieldMatcher(TextMatcher fieldMatcher)
void	setIgnoreContent(boolean ignoreContent)
void	setLogLevel(String logLevel)
String	toString()

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

LogCommitter

public LogCommitter()

Method Detail

isIgnoreContent

public boolean isIgnoreContent()

setIgnoreContent

public void setIgnoreContent(boolean ignoreContent)

getFieldMatcher

public TextMatcher getFieldMatcher()

setFieldMatcher

public void setFieldMatcher(TextMatcher fieldMatcher)

getLogLevel

public String getLogLevel()

setLogLevel

public void setLogLevel(String logLevel)

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

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

loadCommitterFromXML

public void loadCommitterFromXML(XML xml)

Specified by:

loadCommitterFromXML in class AbstractCommitter

saveCommitterToXML

public void saveCommitterToXML(XML xml)

Specified by:

saveCommitterToXML in class AbstractCommitter