org.apache.tika.metadata.filter

Class CaptureGroupMetadataFilter

java.lang.Object

org.apache.tika.config.ConfigBase

org.apache.tika.metadata.filter.MetadataFilter

org.apache.tika.metadata.filter.CaptureGroupMetadataFilter

All Implemented Interfaces:

Serializable, Initializable

public class CaptureGroupMetadataFilter
extends MetadataFilter
implements Initializable

This filter runs a regex against the first value in the "sourceField". If the pattern matches, it extracts the first group of the first match and set's the "targetField"'s value to that first group.

If there is a match, this will overwrite whatever value is in the "targetField".

If there is not a match, this filter will be a no-op.

If there are multiple matches, this filter will capture only the first. Open a ticket if you need different behavior.

If the source field has multiple values, this will run the regex against only the first value.

If the source field does not exist, this filter will be a no-op.

If the target field is the same value as the source field, this filter will overwrite the value in that field. Again, if there are multiple values in that field, those will all be overwritten.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CaptureGroupMetadataFilter()

Method Summary

Modifier and Type	Method and Description
void	checkInitialization(InitializableProblemHandler problemHandler)
void	filter(Metadata metadata)
void	initialize(Map<String,Param> params)
void	setRegex(String regex)
void	setSourceField(String sourceField)
void	setTargetField(String targetField)

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

CaptureGroupMetadataFilter

public CaptureGroupMetadataFilter()

Method Detail

filter

public void filter(Metadata metadata)
            throws TikaException

Specified by:

filter in class MetadataFilter

Throws:

TikaException

setRegex

@Field
public void setRegex(String regex)

setSourceField

@Field
public void setSourceField(String sourceField)

setTargetField

@Field
public void setTargetField(String targetField)

initialize

public void initialize(Map<String,Param> params)
                throws TikaConfigException

Specified by:

initialize in interface Initializable

Parameters:

params - params to use for initialization

Throws:

TikaConfigException

checkInitialization

public void checkInitialization(InitializableProblemHandler problemHandler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Parameters:

problemHandler - if there is a problem and no custom initializableProblemHandler has been configured via Initializable parameters, this is called to respond.

Throws:

TikaConfigException