FieldNameMappingFilter (Apache Tika 2.5.0 API)

java.lang.Object
- org.apache.tika.config.ConfigBase
- - org.apache.tika.metadata.filter.MetadataFilter
  - - org.apache.tika.metadata.filter.FieldNameMappingFilter

All Implemented Interfaces:

Serializable
```
public class FieldNameMappingFilter
extends MetadataFilter
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

FieldNameMappingFilter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`filter(Metadata metadata)`
`void`	`setExcludeUnmapped(boolean excludeUnmapped)`	If this is `true` (default), this means that only the fields that have a "from" value in the mapper will be passed through.
`void`	`setMappings(Map<String,String> mappings)`

Methods inherited from class org.apache.tika.metadata.filter.MetadataFilter
load

Methods inherited from class org.apache.tika.config.ConfigBase
buildComposite, buildComposite, buildSingle, buildSingle, configure, handleSettings

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FieldNameMappingFilter
```
public FieldNameMappingFilter()
```
- Method Detail
  - filter
```
public void filter(Metadata metadata)
            throws TikaException
```
    Specified by:
    
    filter in class MetadataFilter
    
    Throws:
    
    TikaException
  - setExcludeUnmapped
```
@Field
public void setExcludeUnmapped(boolean excludeUnmapped)
```
    If this is true (default), this means that only the fields that have a "from" value in the mapper will be passed through. Otherwise, this will pass through all keys/values and mutate the keys that exist in the mappings.
    
    Parameters:
    
    excludeUnmapped -
  - setMappings
```
@Field
public void setMappings(Map<String,String> mappings)
```