com.google.enterprise.connector.util.filter

Class MovePropertyFilter

java.lang.Object

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

com.google.enterprise.connector.util.filter.CopyPropertyFilter

com.google.enterprise.connector.util.filter.MovePropertyFilter

All Implemented Interfaces:

DocumentFilterFactory

public class MovePropertyFilter
extends CopyPropertyFilter

A filter that moves Document Property values to another property. The source property names do not appear in the Document's set of property names.

If the overwrite flag is true, the moved property values replace any existing values of the target property. Otherwise, the moved property values supplement any existing values of the target property.

Example documentFilters.xml Configurations:

The following example moves HeadLine and ByLine property values to the Title and Author properties, respectively. The original HeadLine and ByLine properties will not be indexed and will not be searchable. This latter behaviour differs from the CopyPropertyFilter from which this filter derives.

   <!-- Make news articles appear in title and author searches. -->
   <bean id="MoveNewsProps"
      class="com.google.enterprise.connector.util.filter.CopyPropertyFilter">
     <property name="propertyNameMap">
       <map>
         <entry key="HeadLine" value="Title"/>
         <entry key="ByLine" value="Author"/>
       </map>
     </property>
     <property name="overwrite" value="false"/>
   </bean>
   

Since:

2.8

Constructor Summary

Constructors

Constructor and Description
MovePropertyFilter()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getPropertyNames(Document source) Gets the set of names of all Properties in the Document, substituting original names of renamed Properties with the new name.

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

findProperty, setOverwrite, setPropertyNameMap, 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

MovePropertyFilter

public MovePropertyFilter()

Method Detail

getPropertyNames

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

Gets the set of names of all Properties in the Document, substituting original names of renamed Properties with the new name.

Overrides:

getPropertyNames in class CopyPropertyFilter

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