com.norconex.importer.handler.filter.impl

Class EmptyMetadataFilter

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.filter.AbstractDocumentFilter

com.norconex.importer.handler.filter.impl.EmptyMetadataFilter

All Implemented Interfaces:

IXMLConfigurable, IDocumentFilter, IOnMatchFilter, IImporterHandler

public class EmptyMetadataFilter
extends AbstractDocumentFilter

Accepts or rejects a document based on whether any of the specified metadata fields are empty or not. Any control characters (char <= 32) are removed before evaluating if a property is empty or not.

XML configuration usage:

  <filter class="com.norconex.importer.handler.filter.impl.EmptyMetadataFilter"
          onMatch="[include|exclude]" 
          fields="(coma separated list of fields 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) -->
  </filter>
 

Usage example:

To exclude documents without titles:

  <filter class="com.norconex.importer.handler.filter.impl.EmptyMetadataFilter"
          onMatch="exclude" fields="title,dc:title" />
 

Since:

1.2

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
EmptyMetadataFilter()
EmptyMetadataFilter(OnMatch onMatch, String... properties)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String[]	getFields()
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	setFields(String... properties)
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

EmptyMetadataFilter

public EmptyMetadataFilter()

EmptyMetadataFilter

public EmptyMetadataFilter(OnMatch onMatch,
                           String... properties)

Method Detail

getFields

public String[] getFields()

setFields

public void setFields(String... properties)

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