com.norconex.importer.handler.filter.impl

Class NumericMetadataFilter

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.filter.AbstractDocumentFilter

com.norconex.importer.handler.filter.impl.NumericMetadataFilter

All Implemented Interfaces:

IXMLConfigurable, IDocumentFilter, IOnMatchFilter, IImporterHandler

public class NumericMetadataFilter
extends AbstractDocumentFilter

Accepts or rejects a document based on the numeric value(s) of a metadata field, supporting decimals. If multiple values are found for a field, only one of them needs to match for this filter to take effect. If the value is not a valid number, it is considered not to be matching. The decimal character is expected to be a dot. To reject decimals or to deal with non-numeric fields in your own way, you can use RegexMetadataFilter.

XML configuration usage:

  <filter class="com.norconex.importer.handler.filter.impl.NumericMetadataFilter"
          onMatch="[include|exclude]" 
          field="(name of metadata field 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) -->

      <!-- Use one or two (for ranges) conditions,
           where possible operators are: 

               gt -> greater than
               ge -> greater equal
               lt -> lower than
               le -> lowe equal
               eq -> equals
        -->

      <condition operator="[gt|ge|lt|le|eq]" number="(number)" />
      
  </filter>
 

Usage example:

For example, let's say you are importing customer profile documents and you have a field called "age" and you need to only consider documents for customers in their twenties (greater or equal to 20, but lower than 30). The following would achieve that

  <filter class="com.norconex.importer.handler.filter.impl.NumericMetadataFilter"
          onMatch="include" field="age" >
      <condition operator="ge" number="20" />
      <condition operator="lt" number="30" />
  </filter>
 

Since:

2.2.0

Author:

Pascal Essiembre

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NumericMetadataFilter.Condition
static class	NumericMetadataFilter.Operator

Constructor Summary

Constructors

Constructor and Description
NumericMetadataFilter()
NumericMetadataFilter(String field)
NumericMetadataFilter(String field, OnMatch onMatch)

Method Summary

Modifier and Type	Method and Description
void	addCondition(NumericMetadataFilter.Operator operator, double number)
boolean	equals(Object other)
List<NumericMetadataFilter.Condition>	getConditions()
String	getField()
int	hashCode()
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	setConditions(NumericMetadataFilter.Condition... conditions)
void	setField(String property)
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

NumericMetadataFilter

public NumericMetadataFilter()

NumericMetadataFilter

public NumericMetadataFilter(String field)

NumericMetadataFilter

public NumericMetadataFilter(String field,
                             OnMatch onMatch)

Method Detail

getField

public String getField()

setField

public void setField(String property)

getConditions

public List<NumericMetadataFilter.Condition> getConditions()

setConditions

public void setConditions(NumericMetadataFilter.Condition... conditions)

addCondition

public void addCondition(NumericMetadataFilter.Operator operator,
                         double number)

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

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractDocumentFilter

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDocumentFilter

toString

public String toString()

Overrides:

toString in class AbstractDocumentFilter