com.norconex.importer.handler.filter.impl

Class RegexMetadataFilter

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.filter.AbstractDocumentFilter

com.norconex.importer.handler.filter.impl.RegexMetadataFilter

All Implemented Interfaces:

IXMLConfigurable, IDocumentFilter, IOnMatchFilter, IImporterHandler

public class RegexMetadataFilter
extends AbstractDocumentFilter

Accepts or rejects a document based on its field values using regular expression.

XML configuration usage:

  <filter class="com.norconex.importer.handler.filter.impl.RegexMetadataFilter"
          onMatch="[include|exclude]" 
          caseSensitive="[false|true]"
          field="(name of metadata name to match)" >
          
      <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 "potato" in the title.

  <filter class="com.norconex.importer.handler.filter.impl.RegexMetadataFilter"
          onMatch="include" field="title" >
      <regex>.*potato.*</regex>
  </filter>
 

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
RegexMetadataFilter()
RegexMetadataFilter(String field, String regex)
RegexMetadataFilter(String field, String regex, OnMatch onMatch)
RegexMetadataFilter(String property, String regex, OnMatch onMatch, boolean caseSensitive)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getField()
String	getRegex()
int	hashCode()
boolean	isCaseSensitive()
protected boolean	isDocumentMatched(String reference, InputStream input, ImporterMetadata metadata, boolean parsed)
protected void	loadFilterFromXML(org.apache.commons.configuration.XMLConfiguration xml)
protected void	saveFilterToXML(EnhancedXMLStreamWriter writer)
void	setCaseSensitive(boolean caseSensitive)
void	setField(String property)
void	setRegex(String regex)
String	toString()

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

RegexMetadataFilter

public RegexMetadataFilter()

RegexMetadataFilter

public RegexMetadataFilter(String field,
                           String regex)

RegexMetadataFilter

public RegexMetadataFilter(String field,
                           String regex,
                           OnMatch onMatch)

RegexMetadataFilter

public RegexMetadataFilter(String property,
                           String regex,
                           OnMatch onMatch,
                           boolean caseSensitive)

Method Detail

getRegex

public String getRegex()

setRegex

public final void setRegex(String regex)

isCaseSensitive

public boolean isCaseSensitive()

getField

public String getField()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

setField

public void setField(String property)

isDocumentMatched

protected boolean isDocumentMatched(String reference,
                                    InputStream input,
                                    ImporterMetadata metadata,
                                    boolean parsed)
                             throws ImporterHandlerException

Specified by:

isDocumentMatched in class AbstractDocumentFilter

Throws:

ImporterHandlerException

loadFilterFromXML

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

Specified by:

loadFilterFromXML in class AbstractDocumentFilter

Throws:

IOException

saveFilterToXML

protected void saveFilterToXML(EnhancedXMLStreamWriter writer)
                        throws XMLStreamException

Specified by:

saveFilterToXML in class AbstractDocumentFilter

Throws:

XMLStreamException

toString

public String toString()

Overrides:

toString in class AbstractDocumentFilter

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDocumentFilter

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractDocumentFilter