Pattern capture token filter

The pattern_capture token filter, unlike the pattern tokenizer, emits a token for every capture group in the regular expression. Patterns are not anchored to the beginning and end of the string, so each pattern can match multiple times, and matches are allowed to overlap.

Beware of Pathological Regular Expressions

The pattern capture token filter uses Java Regular Expressions.

A badly written regular expression could run very slowly or even throw a StackOverflowError and cause the node it is running on to exit suddenly.

Read more about pathological regular expressions and how to avoid them.

For instance a pattern like :

  1. "(([a-z]+)(\d*))"

when matched against:

  1. "abc123def456"

would produce the tokens: [ abc123, abc, 123, def456, def, 456 ]

If preserve_original is set to true (the default) then it would also emit the original token: abc123def456.

This is particularly useful for indexing text like camel-case code, eg stripHTML where a user may search for "strip html" or "striphtml":

  1. PUT test
  2. {
  3.    "settings" : {
  4.       "analysis" : {
  5.          "filter" : {
  6.             "code" : {
  7.                "type" : "pattern_capture",
  8.                "preserve_original" : true,
  9.                "patterns" : [
  10.                   "(\\p{Ll}+|\\p{Lu}\\p{Ll}+|\\p{Lu}+)",
  11.                   "(\\d+)"
  12.                ]
  13.             }
  14.          },
  15.          "analyzer" : {
  16.             "code" : {
  17.                "tokenizer" : "pattern",
  18.                "filter" : [ "code", "lowercase" ]
  19.             }
  20.          }
  21.       }
  22.    }
  23. }

When used to analyze the text

  1. import static org.apache.commons.lang.StringEscapeUtils.escapeHtml

this emits the tokens: [ import, static, org, apache, commons, lang, stringescapeutils, string, escape, utils, escapehtml, escape, html ]

Another example is analyzing email addresses:

  1. PUT test
  2. {
  3.    "settings" : {
  4.       "analysis" : {
  5.          "filter" : {
  6.             "email" : {
  7.                "type" : "pattern_capture",
  8.                "preserve_original" : true,
  9.                "patterns" : [
  10.                   "([^@]+)",
  11.                   "(\\p{L}+)",
  12.                   "(\\d+)",
  13.                   "@(.+)"
  14.                ]
  15.             }
  16.          },
  17.          "analyzer" : {
  18.             "email" : {
  19.                "tokenizer" : "uax_url_email",
  20.                "filter" : [ "email", "lowercase",  "unique" ]
  21.             }
  22.          }
  23.       }
  24.    }
  25. }

When the above analyzer is used on an email address like:

  1. john-smith_123@foo-bar.com

it would produce the following tokens:

  1. john-smith_123@foo-bar.com, john-smith_123,
  2. john, smith, 123, foo-bar.com, foo, bar, com

Multiple patterns are required to allow overlapping captures, but also means that patterns are less dense and easier to understand.

Note: All tokens are emitted in the same position, and with the same character offsets. This means, for example, that a match query for john-smith_123@foo-bar.com that uses this analyzer will return documents containing any of these tokens, even when using the and operator. Also, when combined with highlighting, the whole original token will be highlighted, not just the matching subset. For instance, querying the above email address for "smith" would highlight:

  1.   <em>john-smith_123@foo-bar.com</em>

not:

  1.   john-<em>smith</em>_123@foo-bar.com