com.norconex.importer.handler.filter.impl

Class RegexReferenceFilter

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.filter.AbstractDocumentFilter

com.norconex.importer.handler.filter.impl.RegexReferenceFilter

All Implemented Interfaces:

IXMLConfigurable, IDocumentFilter, IOnMatchFilter, IImporterHandler

public class RegexReferenceFilter
extends AbstractDocumentFilter

Accepts or rejects a document based on its reference (e.g. URL).

XML configuration usage:

  <filter class="com.norconex.importer.handler.filter.impl.RegexReferenceFilter"
          onMatch="[include|exclude]" 
          caseSensitive="[false|true]">
          
      <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 reference to match)</regex>
  </filter>
 

Can be used both as a pre-parse or post-parse handler.

Usage example:

The following will reject documents having "/login/" in their reference.

  <filter class="com.norconex.importer.handler.filter.impl.RegexReferenceFilter"
          onMatch="exclude">
      <regex>.*/login/.*</regex>
  </filter> 
 

Since:

2.7.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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	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

RegexReferenceFilter

public RegexReferenceFilter()

RegexReferenceFilter

public RegexReferenceFilter(String regex)

RegexReferenceFilter

public RegexReferenceFilter(String regex,
                            OnMatch onMatch)

RegexReferenceFilter

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

Method Detail

getRegex

public String getRegex()

isCaseSensitive

public boolean isCaseSensitive()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

setRegex

public final void setRegex(String regex)

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