com.google.enterprise.connector.util.filter

Class DeletePropertyFilter

java.lang.Object

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

com.google.enterprise.connector.util.filter.DeletePropertyFilter

All Implemented Interfaces:

DocumentFilterFactory

public class DeletePropertyFilter
extends AbstractDocumentFilter

A Document filter that removes the specified Properties from the document. The deleted properties are not fed to the GSA and do not appear in the set of properties available from the document.

Example documentFilters.xml Configuration:

The following example filters out the Department and Section properties from the document.

   <!-- Remove Department and Section properties. -->
   <bean id="DeleteDeptAndSect"
      class="com.google.enterprise.connector.util.filter.DeletePropertyFilter">
     <property name="propertyNames">
       <set>
         <value>Department</value>
         <value>Section</value>
       </set>
     </property>
   </bean>
   

Since:

2.8

Constructor Summary

Constructors

Constructor and Description
DeletePropertyFilter()

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 Document, removing the names of deleted Properties from the Set returned by the source Document.
void	setPropertyName(java.lang.String propertyName) Sets the the name of the Property to remove.
void	setPropertyNames(java.util.Set<java.lang.String> propertyNames) Sets the the names of the Properties to remove.
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

DeletePropertyFilter

public DeletePropertyFilter()

Method Detail

setPropertyName

public void setPropertyName(java.lang.String propertyName)

Sets the the name of the Property to remove.

Parameters:

propertyName - the name of the Property to remove

Throws:

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

setPropertyNames

public void setPropertyNames(java.util.Set<java.lang.String> propertyNames)

Sets the the names of the Properties to remove.

Parameters:

propertyNames - a Set of names of the Properties to remove

Throws:

java.lang.NullPointerException - if propertyNames is null

findProperty

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

Finds a Property by name. If the Document has a property of that name, and that property has not been deleted, then the property is returned.

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

getPropertyNames

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

Gets the set of names of all Properties in the Document, removing the names of deleted Properties from the Set returned by the source Document.

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

toString

public java.lang.String toString()

Overrides:

toString in class AbstractDocumentFilter