com.norconex.committer.core3.impl

Class MemoryCommitter

java.lang.Object

com.norconex.committer.core3.AbstractCommitter

com.norconex.committer.core3.impl.MemoryCommitter

All Implemented Interfaces:

ICommitter, IXMLConfigurable, AutoCloseable

public class MemoryCommitter
extends AbstractCommitter

WARNING: Not intended for production use.

A Committer that stores every document received into memory. This can be useful for testing or troubleshooting applications using Committers. Given this committer can eat up memory pretty quickly, its use is strongly discouraged for regular production use.

XML configuration usage:

<committer
    class="com.norconex.committer.core3.impl.MemoryCommitter">
  <!-- 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
MemoryCommitter() Constructor.

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)
List<ICommitterRequest>	getAllRequests()
int	getDeleteCount()
List<DeleteRequest>	getDeleteRequests()
TextMatcher	getFieldMatcher()
int	getRequestCount()
int	getUpsertCount()
List<UpsertRequest>	getUpsertRequests()
int	hashCode()
boolean	isIgnoreContent()
void	loadCommitterFromXML(XML xml)
boolean	removeRequest(ICommitterRequest req)
void	saveCommitterToXML(XML xml)
void	setFieldMatcher(TextMatcher fieldMatcher)
void	setIgnoreContent(boolean ignoreContent)
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

Constructor Detail

MemoryCommitter

public MemoryCommitter()

Constructor.

Method Detail

isIgnoreContent

public boolean isIgnoreContent()

setIgnoreContent

public void setIgnoreContent(boolean ignoreContent)

getFieldMatcher

public TextMatcher getFieldMatcher()

setFieldMatcher

public void setFieldMatcher(TextMatcher fieldMatcher)

doInit

protected void doInit()

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

removeRequest

public boolean removeRequest(ICommitterRequest req)

getAllRequests

public List<ICommitterRequest> getAllRequests()

getUpsertRequests

public List<UpsertRequest> getUpsertRequests()

getDeleteRequests

public List<DeleteRequest> getDeleteRequests()

getUpsertCount

public int getUpsertCount()

getDeleteCount

public int getDeleteCount()

getRequestCount

public int getRequestCount()

doUpsert

protected void doUpsert(UpsertRequest upsertRequest)
                 throws CommitterException

Specified by:

doUpsert in class AbstractCommitter

Throws:

CommitterException

doDelete

protected void doDelete(DeleteRequest deleteRequest)

Specified by:

doDelete in class AbstractCommitter

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