GenericReferenceFilter

Filter references by matching text expression.

crawler/coreJavadoc: GenericReferenceFilter

Notes

Filters document references using a configurable text matcher. References that match the expression are either included or excluded depending on the onMatch setting.

Examples

The following will reject documents having "/login/" in their reference.

YAML

class: GenericReferenceFilter
onMatch: EXCLUDE
valueMatcher:
  method: REGEX
  pattern: .*/login/.*

JSON

{
  "class": "GenericReferenceFilter",
  "onMatch": "EXCLUDE",
  "valueMatcher": {
    "method": "REGEX",
    "pattern": ".*/login/.*"
  }
}

XML

<class>GenericReferenceFilter</class>
<onMatch>EXCLUDE</onMatch>
<valueMatcher>
  <method>REGEX</method>
  <pattern>.*&#47;login/.*</pattern>
</valueMatcher>

Usage

Full configuration skeleton, with every option and its default

YAML

class: GenericReferenceFilter
onMatch: INCLUDE
valueMatcher:
  ignoreCase: false
  ignoreDiacritic: false
  matchEmpty: false
  method: BASIC
  negateMatches: false
  partial: false
  pattern: string
  replaceAll: false
  trim: false

JSON

{
  "class": "GenericReferenceFilter",
  "onMatch": "INCLUDE",
  "valueMatcher": {
    "ignoreCase": false,
    "ignoreDiacritic": false,
    "matchEmpty": false,
    "method": "BASIC",
    "negateMatches": false,
    "partial": false,
    "pattern": "string",
    "replaceAll": false,
    "trim": false
  }
}

XML

<genericReferenceFilter>
  <class>GenericReferenceFilter</class>
  <onMatch>INCLUDE</onMatch>
  <valueMatcher>
    <ignoreCase>false</ignoreCase>
    <ignoreDiacritic>false</ignoreDiacritic>
    <matchEmpty>false</matchEmpty>
    <method>BASIC</method>
    <negateMatches>false</negateMatches>
    <partial>false</partial>
    <pattern>string</pattern>
    <replaceAll>false</replaceAll>
    <trim>false</trim>
  </valueMatcher>
</genericReferenceFilter>

Properties

Property	Type	Required	Default
onMatch	enum	No	INCLUDE
valueMatcher	TextMatcher	No	-

Property Details

onMatch

What to do with a matching reference.

Allowed Values

• INCLUDE
• EXCLUDE

valueMatcher

Use the following fields to dictate how references should be matched by this filter.