com.norconex.importer.handler.filter.impl

Class RegexContentFilter

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.filter.AbstractDocumentFilter

com.norconex.importer.handler.filter.AbstractCharStreamFilter

com.norconex.importer.handler.filter.AbstractStringFilter

com.norconex.importer.handler.filter.impl.RegexContentFilter

All Implemented Interfaces:

IXMLConfigurable, IDocumentFilter, IOnMatchFilter, IImporterHandler

public class RegexContentFilter
extends AbstractStringFilter

Filters a document based on a pattern matching in its content. Based on document size, it is possible the pattern matching will be done in chunks, sometimes not achieving expected results. Consider using AbstractCharStreamFilter if this is a concern. Refer to AbstractDocumentFilter for the inclusion/exclusion logic.

Since 2.2.0, the following regular expression flags are always active: Pattern.MULTILINE and Pattern.DOTALL.

XML configuration usage:

  <filter class="com.norconex.importer.handler.filter.impl.RegexContentFilter"
          onMatch="[include|exclude]" 
          caseSensitive="[false|true]"
          sourceCharset="(character encoding)"
          maxReadSize="(max characters to read at once)" >
          
      <restrictTo caseSensitive="[false|true]"
              field="(name of header/metadata field name to match)">
          (regular expression of value to match)
      </restrictTo>
      <!-- multiple "restrictTo" tags allowed (only one needs to match) -->
          
      <regex>(regular expression of value to match)</regex>
  </filter>
 

Usage example:

This example will accept only documents containing word "apple".

  <filter class="com.norconex.importer.handler.filter.impl.RegexContentFilter"
          onMatch="include" >
      <regex>.*apple.*</regex>
  </filter>
 

Since:

2.0.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
RegexContentFilter()
RegexContentFilter(String regex)
RegexContentFilter(String regex, OnMatch onMatch)
RegexContentFilter(String regex, OnMatch onMatch, boolean caseSensitive)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getRegex()
int	hashCode()
boolean	isCaseSensitive()
protected boolean	isStringContentMatching(String reference, StringBuilder content, ImporterMetadata metadata, boolean parsed, int sectionIndex)
protected void	loadStringFilterFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
protected void	saveStringFilterToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	setCaseSensitive(boolean caseSensitive)
void	setRegex(String regex)
String	toString()

Methods inherited from class com.norconex.importer.handler.filter.AbstractStringFilter

getMaxReadSize, isTextDocumentMatching, loadCharStreamFilterFromXML, saveCharStreamFilterToXML, setMaxReadSize

Methods inherited from class com.norconex.importer.handler.filter.AbstractCharStreamFilter

getSourceCharset, isDocumentMatched, loadFilterFromXML, saveFilterToXML, setSourceCharset

Methods inherited from class com.norconex.importer.handler.filter.AbstractDocumentFilter

acceptDocument, getOnMatch, loadHandlerFromXML, saveHandlerToXML, setOnMatch

Methods inherited from class com.norconex.importer.handler.AbstractImporterHandler

addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, getRestrictions, isApplicable, loadFromXML, removeRestriction, removeRestriction, saveToXML

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexContentFilter

public RegexContentFilter()

RegexContentFilter

public RegexContentFilter(String regex)

RegexContentFilter

public RegexContentFilter(String regex,
                          OnMatch onMatch)

RegexContentFilter

public RegexContentFilter(String regex,
                          OnMatch onMatch,
                          boolean caseSensitive)

Method Detail

getRegex

public String getRegex()

setRegex

public final void setRegex(String regex)

isCaseSensitive

public boolean isCaseSensitive()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

isStringContentMatching

protected boolean isStringContentMatching(String reference,
                                          StringBuilder content,
                                          ImporterMetadata metadata,
                                          boolean parsed,
                                          int sectionIndex)
                                   throws ImporterHandlerException

Specified by:

isStringContentMatching in class AbstractStringFilter

Throws:

ImporterHandlerException

saveStringFilterToXML

protected void saveStringFilterToXML(EnhancedXMLStreamWriter writer)
                              throws XMLStreamException

Description copied from class: AbstractStringFilter

Saves configuration settings specific to the implementing class. The parent tag along with the "class" attribute are already written. Implementors must not close the writer.

Specified by:

saveStringFilterToXML in class AbstractStringFilter

Parameters:

writer - the xml writer

Throws:

XMLStreamException - could not save to XML

loadStringFilterFromXML

protected void loadStringFilterFromXML(org.apache.commons.configuration.XMLConfiguration xml)
                                throws IOException

Description copied from class: AbstractStringFilter

Loads configuration settings specific to the implementing class.

Specified by:

loadStringFilterFromXML in class AbstractStringFilter

Parameters:

xml - xml configuration

Throws:

IOException - could not load from XML

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractStringFilter

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStringFilter

toString

public String toString()

Overrides:

toString in class AbstractStringFilter