com.google.enterprise.connector.util.filter

Class SkipDocumentFilter

java.lang.Object

com.google.enterprise.connector.util.filter.AbstractDocumentFilter

com.google.enterprise.connector.util.filter.SkipDocumentFilter

All Implemented Interfaces:

DocumentFilterFactory

public class SkipDocumentFilter
extends AbstractDocumentFilter

A Document filter that forces a Document to be skipped (or not) based upon the presence/abscence of a specific Property, or based upon a match on one of the Values of that property.

Example documentFilters.xml Configurations:

The following example skips documents that have a NoIndex Property.

   <bean id="NoIndex"
      class="com.google.enterprise.connector.util.filter.SkipDocumentFilter">
     <property name="propertyName" value="NoIndex"/>
     <property name="skipOnMatch" value="true"/>
   </bean>
   

The following example skips documnents whose Classification Property value is not PUBLIC or DECLASSIFIED.

   <!-- Filter out all but PUBLIC and DECLASSIFIED documents. -->
   <bean id="Classified"
      class="com.google.enterprise.connector.util.filter.SkipDocumentFilter">
     <property name="propertyName" value="Classification"/>
     <property name="pattern" value="(PUBLIC)|(DECLASSIFIED)"/>
     <property name="skipOnMatch" value="false"/>
   </bean>
   

Since:

2.8.4

Constructor Summary

Constructors

Constructor and Description
SkipDocumentFilter()

Method Summary

Modifier and Type	Method and Description
Property	findProperty(Document source, java.lang.String name) Finds a Property by name.
java.util.Set<java.lang.String>	getPropertyNames(Document source) Gets the set of names of all Properties in the source Document.
void	setPattern(java.lang.String pattern) Sets the regular expression pattern to match in the values.
void	setPropertyName(java.lang.String propertyName) Sets the the name of the Property to match.
void	setSkipOnMatch(boolean skipOnMatch) Sets the skip document behaviour flag.
java.lang.String	toString()

Methods inherited from class com.google.enterprise.connector.util.filter.AbstractDocumentFilter

getPropertyValues, newDocumentFilter

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SkipDocumentFilter

public SkipDocumentFilter()

Method Detail

setPropertyName

public void setPropertyName(java.lang.String propertyName)

Sets the the name of the Property to match. If no pattern is set, then any Document that exposes the named property is considered a matching document. If a pattern is set, then any value of the property that matches the regular expression is considered a match.

Parameters:

propertyName - the name of the Property to filter

Throws:

java.lang.IllegalArgumentException - if propertyName is null or empty

setPattern

public void setPattern(java.lang.String pattern)
                throws java.util.regex.PatternSyntaxException

Sets the regular expression pattern to match in the values. The supplied pattern must conform to the syntax defined in Pattern. If one of the property's values matches this regular expression, this is considered a matching document.

If no pattern is specified, then the mere presence of the named property would be considered a match.

Parameters:

pattern - the regular expression pattern to match in the values

Throws:

java.util.regex.PatternSyntaxException - if pattern's syntax is invalid

setSkipOnMatch

public void setSkipOnMatch(boolean skipOnMatch)

Sets the skip document behaviour flag. If true skip the document on a match. If false skip the document on a failed match.

Parameters:

skipOnMatch - If true skip the document on a match, otherwise skip the document if the match fails.

getPropertyNames

public java.util.Set<java.lang.String> getPropertyNames(Document source)
                                                 throws RepositoryException

Description copied from class: AbstractDocumentFilter

Gets the set of names of all Properties in the source Document.

Filter subclasses are likely to override this method.

Overrides:

getPropertyNames in class AbstractDocumentFilter

Parameters:

source - the source Document for this filter

Returns:

the names, as a Set of Strings

Throws:

RepositoryException - if a repository access error occurs

RepositoryDocumentException - if a document has fatal processing errors

findProperty

public Property findProperty(Document source,
                             java.lang.String name)
                      throws RepositoryException

Description copied from class: AbstractDocumentFilter

Finds a Property by name. If the source Document has a property of that name, then that property is returned.

Filter subclasses are likely to override this method.

Overrides:

findProperty in class AbstractDocumentFilter

Parameters:

source - the source Document for this filter

name - the name of the property to find

Returns:

the Property, if found; null otherwise

Throws:

RepositoryException - if a repository access error occurs

RepositoryDocumentException - if a document has fatal processing errors

toString

public java.lang.String toString()

Overrides:

toString in class AbstractDocumentFilter