com.google.enterprise.connector.util.filter

Class CopyPropertyFilter

java.lang.Object

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

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

All Implemented Interfaces:

DocumentFilterFactory

Direct Known Subclasses:

MovePropertyFilter

public class CopyPropertyFilter
extends AbstractDocumentFilter

A Document filter that copies a Property's values to another property. The new property name is added to the Document's set of properties, if it is not already in that set.

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

Example documentFilters.xml Configurations:

The following example copies HeadLine and ByLine property values to the Title and Author properties, respectively. The original HeadLine and ByLine properties will still be indexed and searchable.

   <!-- 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
CopyPropertyFilter()

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, including any new Properties that might be produced by copying other Properties.
void	setOverwrite(boolean overwrite) Sets the overwrite values flag.
void	setPropertyNameMap(java.util.Map<java.lang.String,java.lang.String> propertyNameMap) Sets the property name map.
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

CopyPropertyFilter

public CopyPropertyFilter()

Method Detail

setPropertyNameMap

public void setPropertyNameMap(java.util.Map<java.lang.String,java.lang.String> propertyNameMap)

Sets the property name map. This Map<String, String> maps source property name (the key) to the destination property name (the value).

Parameters:

propertyNameMap - sourceName-to-destinationName Map

Throws:

java.lang.NullPointerException - if propertyNameMap is null

setOverwrite

public void setOverwrite(boolean overwrite)

Sets the overwrite values flag. If true, any existing values of the copied-to property are overwritten with the copied values. If false, the copied values augment those of the copied-to property. Default overwrite is false.

Parameters:

overwrite - the overwrite flag

findProperty

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

Finds a Property by name. If the requested property is configured as a copy from another property, then that other property's values are copied to the named property. If the overwrite flag is true, then the copied property values replace any existing values of the requested property. Otherwise, the copied property values supplement any existing values of the requested property.

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, including any new Properties that might be produced by copying other Properties.

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