com.norconex.committer.core3

Class AbstractCommitter

java.lang.Object

com.norconex.committer.core3.AbstractCommitter

All Implemented Interfaces:

ICommitter, IXMLConfigurable, AutoCloseable

Direct Known Subclasses:

AbstractBatchCommitter, AbstractFSCommitter, LogCommitter, MemoryCommitter

public abstract class AbstractCommitter
extends Object
implements ICommitter, IXMLConfigurable

A base implementation taking care of basic plumbing, such as firing main Committer events (including exceptions), storing the Committer context (available via getCommitterContext()), and adding support for filtering unwanted requests.

Restricting committer to specific documents

Optionally apply a committer only to certain type of documents. Documents are restricted based on their metadata field names and values. This option can be used to perform document routing when you have multiple committers defined.

Field mappings

By default, this abstract class applies field mappings for metadata fields, but leaves the document reference and content (input stream) for concrete implementations to handle. In other words, they only apply to a committer request metadata. Field mappings are performed on committer requests before upserts and deletes are actually performed.

XML configuration usage:

<!-- 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>

Implementing classes inherit the above XML configuration.

Since:

3.0.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
AbstractCommitter()

Method Summary

Modifier and Type	Method and Description
boolean	accept(ICommitterRequest request)
void	addRestriction(PropertyMatcher... restrictions) Adds one or more restrictions this committer should be restricted to.
void	addRestrictions(List<PropertyMatcher> restrictions) Adds restrictions this committer should be restricted to.
protected void	applyFieldMappings(ICommitterRequest req)
void	clean() Cleans any persisted information (e.g.
void	clearFieldMappings()
void	clearRestrictions() Clears all restrictions.
void	close()
void	delete(DeleteRequest deleteRequest)
protected abstract void	doClean()
protected abstract void	doClose() Subclasses can perform additional closing logic by overriding this method.
protected abstract void	doDelete(DeleteRequest deleteRequest)
protected abstract void	doInit() Subclasses can perform additional initialization by overriding this method.
protected abstract void	doUpsert(UpsertRequest upsertRequest)
boolean	equals(Object other)
protected void	fireDebug(String name)
protected void	fireDebug(String name, ICommitterRequest req)
protected void	fireError(String name, Exception e)
protected void	fireError(String name, ICommitterRequest req, Exception e)
protected void	fireInfo(String name)
protected void	fireInfo(String name, ICommitterRequest req)
CommitterContext	getCommitterContext()
Map<String,String>	getFieldMappings() Gets an unmodifiable copy of the metadata mappings.
PropertyMatchers	getRestrictions() Gets all restrictions
int	hashCode()
void	init(CommitterContext committerContext)
abstract void	loadCommitterFromXML(XML xml)
void	loadFromXML(XML xml)
String	removeFieldMapping(String fromField)
boolean	removeRestriction(PropertyMatcher restriction) Removes a restriction.
int	removeRestriction(String field) Removes all restrictions on a given field.
abstract void	saveCommitterToXML(XML xml)
void	saveToXML(XML xml)
void	setFieldMapping(String fromField, String toField) Sets a metadata field mapping.
void	setFieldMappings(Map<String,String> mappings) Sets a metadata field mappings, where the key is the source field and the value is the target field.
String	toString()
void	upsert(UpsertRequest upsertRequest)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCommitter

public AbstractCommitter()

Method Detail

addRestriction

public void addRestriction(PropertyMatcher... restrictions)

Adds one or more restrictions this committer should be restricted to.

Parameters:

restrictions - the restrictions

addRestrictions

public void addRestrictions(List<PropertyMatcher> restrictions)

Adds restrictions this committer should be restricted to.

Parameters:

restrictions - the restrictions

removeRestriction

public int removeRestriction(String field)

Removes all restrictions on a given field.

Parameters:

field - the field to remove restrictions on

Returns:

how many elements were removed

removeRestriction

public boolean removeRestriction(PropertyMatcher restriction)

Removes a restriction.

Parameters:

restriction - the restriction to remove

Returns:

true if this committer contained the restriction

clearRestrictions

public void clearRestrictions()

Clears all restrictions.

getRestrictions

public PropertyMatchers getRestrictions()

Gets all restrictions

Returns:

the restrictions

Since:

2.4.0

getFieldMappings

public Map<String,String> getFieldMappings()

Gets an unmodifiable copy of the metadata mappings.

Returns:

metadata mappings

setFieldMapping

public void setFieldMapping(String fromField,
                            String toField)

Sets a metadata field mapping.

Parameters:

fromField - source field

toField - target field

setFieldMappings

public void setFieldMappings(Map<String,String> mappings)

Sets a metadata field mappings, where the key is the source field and the value is the target field.

Parameters:

mappings - metadata field mappings

removeFieldMapping

public String removeFieldMapping(String fromField)

clearFieldMappings

public void clearFieldMappings()

init

public final void init(CommitterContext committerContext)
                throws CommitterException

Specified by:

init in interface ICommitter

Throws:

CommitterException

accept

public boolean accept(ICommitterRequest request)
               throws CommitterException

Specified by:

accept in interface ICommitter

Throws:

CommitterException

upsert

public final void upsert(UpsertRequest upsertRequest)
                  throws CommitterException

Specified by:

upsert in interface ICommitter

Throws:

CommitterException

delete

public final void delete(DeleteRequest deleteRequest)
                  throws CommitterException

Specified by:

delete in interface ICommitter

Throws:

CommitterException

applyFieldMappings

protected void applyFieldMappings(ICommitterRequest req)

close

public final void close()
                 throws CommitterException

Specified by:

close in interface ICommitter

Specified by:

close in interface AutoCloseable

Throws:

CommitterException

clean

public final void clean()
                 throws CommitterException

Description copied from interface: ICommitter

Cleans any persisted information (e.g. queue) to ensure next run will start fresh. Calling this method on Committers not persisting anything between each execution will have no effect. This method does NOT delete anything previously committed on the target repository.

Specified by:

clean in interface ICommitter

Throws:

CommitterException - something went wrong cleaning the committer.

getCommitterContext

public CommitterContext getCommitterContext()

doInit

protected abstract void doInit()
                        throws CommitterException

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

Throws:

CommitterException - error initializing

doUpsert

protected abstract void doUpsert(UpsertRequest upsertRequest)
                          throws CommitterException

Throws:

CommitterException

doDelete

protected abstract void doDelete(DeleteRequest deleteRequest)
                          throws CommitterException

Throws:

CommitterException

doClose

protected abstract void doClose()
                         throws CommitterException

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

Throws:

CommitterException - error closing committer

doClean

protected abstract void doClean()
                         throws CommitterException

Throws:

CommitterException

fireDebug

protected final void fireDebug(String name)

fireDebug

protected final void fireDebug(String name,
                               ICommitterRequest req)

fireInfo

protected final void fireInfo(String name)

fireInfo

protected final void fireInfo(String name,
                              ICommitterRequest req)

fireError

protected final void fireError(String name,
                               Exception e)

fireError

protected final void fireError(String name,
                               ICommitterRequest req,
                               Exception e)

loadFromXML

public final void loadFromXML(XML xml)

Specified by:

loadFromXML in interface IXMLConfigurable

saveToXML

public final void saveToXML(XML xml)

Specified by:

saveToXML in interface IXMLConfigurable

loadCommitterFromXML

public abstract void loadCommitterFromXML(XML xml)

saveCommitterToXML

public abstract void saveCommitterToXML(XML xml)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object