com.wantedtech.common.xpresso.en.sentence.chunker

Class RegexpChunkRule

java.lang.Object

com.wantedtech.common.xpresso.en.sentence.chunker.RegexpChunkRule

Direct Known Subclasses:

ChinkRule, ChunkRule, ChunkRuleWithContext, MergeRule

public class RegexpChunkRule
extends java.lang.Object

""" A rule specifying how to modify the chunking in a ``ChunkString``, using a transformational regular expression. The ``RegexpChunkRule`` class itself can be used to implement any transformational rule based on regular expressions. There are also a number of subclasses, which can be used to implement simpler types of rules, based on matching regular expressions. Each ``RegexpChunkRule`` has a regular expression and a replacement expression. When a ``RegexpChunkRule`` is "applied" to a ``ChunkString``, it searches the ``ChunkString`` for any substring that matches the regular expression, and replaces it using the replacement expression. This search/replace operation has the same semantics as ``re.sub``. Each ``RegexpChunkRule`` also has a description string, which gives a short (typically less than 75 characters) description of the purpose of the rule. This transformation defined by this ``RegexpChunkRule`` should only add and remove braces; it should *not* modify the sequence of angle-bracket delimited tags. Furthermore, this transformation may not result in nested or mismatched bracketing. """

Author:

andriy.burkov

Constructor Summary

Constructors

Constructor and Description
RegexpChunkRule(Regex regexp, java.lang.String repl, java.lang.String descr) Construct a new RegexpChunkRule.

Method Summary

Modifier and Type	Method and Description
void	apply(ChunkString chunkstr) Apply this rule to the given ChunkString.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RegexpChunkRule

public RegexpChunkRule(Regex regexp,
                       java.lang.String repl,
                       java.lang.String descr)

Construct a new RegexpChunkRule.

Parameters:

regexp: - The regular expression for this ``RegexpChunkRule``. When this rule is applied to a ``ChunkString``, any substring that matches ``regexp`` will be replaced using the replacement string ``repl``. Note that this must be a normal regular expression, not a tag pattern.

repl: - The replacement expression for this ``RegexpChunkRule``. When this rule is applied to a ``ChunkString``, any substring that matches ``regexp`` will be replaced using ``repl``.

descr: - A short description of the purpose and/or effect of this rule.

Method Detail

apply

public void apply(ChunkString chunkstr)

Apply this rule to the given ChunkString. See the class reference documentation for a description of what it means to apply a rule.

Parameters:

chunkstr - The ChunkString to which this rule is applied.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object