com.adaptris.core.metadata

Class RegexMetadataFilter

java.lang.Object

com.adaptris.core.metadata.MetadataFilterImpl

com.adaptris.core.metadata.RegexMetadataFilter

All Implemented Interfaces:

MetadataFilter

public class RegexMetadataFilter
extends MetadataFilterImpl

Regular Expression based implementation of MetadataFilter

Each of the configured include or exclude elements is considered a regular expression as defined by Pattern. These are then matched against the key portion of the MetadataElement.

All the includes are processed first to generate a subset of metadata that is then used to process any exclusions. The include and excludes should be in String regular expression format. If you do not specify any includes, then this implicitly means all elements are included. If you do not specify any excludes then nothing is excluded from the inclusion subset.

Typically, you shouldn't need both includes and excludes because your skill with regular expressions mean that you can handle everything you need in either an includes or an excludes block. It is processed this way for completeness.

In the adapter configuration file this class is aliased as regex-metadata-filter which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
RegexMetadataFilter()

Method Summary

Modifier and Type	Method and Description
void	addExcludePattern(java.lang.String pattern)
void	addIncludePattern(java.lang.String pattern)
MetadataCollection	filter(MetadataCollection original) Return all the metadata that matches the filter.
java.util.List<java.lang.String>	getExcludePatterns()
java.util.List<java.lang.String>	getIncludePatterns()
static boolean	matches(MetadataElement element, java.util.List<java.util.regex.Pattern> patterns)
void	setExcludePatterns(java.util.List<java.lang.String> excludes)
void	setIncludePatterns(java.util.List<java.lang.String> includes)
static java.util.List<java.util.regex.Pattern>	validatePatterns(java.util.List<java.lang.String> patternSpec, java.util.List<java.util.regex.Pattern> existingPatterns)
RegexMetadataFilter	withExcludePatterns(java.lang.String... patterns)
RegexMetadataFilter	withIncludePatterns(java.lang.String... patterns)

Methods inherited from class com.adaptris.core.metadata.MetadataFilterImpl

filter, filter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegexMetadataFilter

public RegexMetadataFilter()

Method Detail

filter

public MetadataCollection filter(MetadataCollection original)

Description copied from interface: MetadataFilter

Return all the metadata that matches the filter.

Parameters:

original - the original set of metadata.

Returns:

a MetadataCollection instance that has been filtered.

getIncludePatterns

public java.util.List<java.lang.String> getIncludePatterns()

setIncludePatterns

public void setIncludePatterns(java.util.List<java.lang.String> includes)

getExcludePatterns

public java.util.List<java.lang.String> getExcludePatterns()

setExcludePatterns

public void setExcludePatterns(java.util.List<java.lang.String> excludes)

addIncludePattern

public void addIncludePattern(java.lang.String pattern)

addExcludePattern

public void addExcludePattern(java.lang.String pattern)

withExcludePatterns

public RegexMetadataFilter withExcludePatterns(java.lang.String... patterns)

withIncludePatterns

public RegexMetadataFilter withIncludePatterns(java.lang.String... patterns)

validatePatterns

public static java.util.List<java.util.regex.Pattern> validatePatterns(java.util.List<java.lang.String> patternSpec,
                                                                       java.util.List<java.util.regex.Pattern> existingPatterns)

matches

public static boolean matches(MetadataElement element,
                              java.util.List<java.util.regex.Pattern> patterns)