org.apache.ctakes.core.util.regex

Class TimeoutMatcher

java.lang.Object

org.apache.ctakes.core.util.regex.TimeoutMatcher

All Implemented Interfaces:

Closeable, AutoCloseable

public class TimeoutMatcher
extends Object
implements Closeable

Class that can / should be used to find text spans using regular expressions. It runs Matcher find Matcher.find() in a separate thread so that it may be interrupted at a set timeout. This prevents infinite loop problems that can be caused by poorly-built expressions or unexpected text contents. The timeout can be specified in milliseconds between 100 and 10,000. Large timeouts are unadvised. If a large amount of text needs to be parsed then it is better to split up the text logically and use smaller timeouts. The default timeout is 1000 milliseconds. Extending Matcher would be better, but it is final

Proper usage is: try ( TimeoutMatcher finder = new TimeoutMatcher( "\\s+", "Hello World !" ) ) { Matcher matcher = finder.find(); while ( matcher != null ) { ... matcher = finder.find(); } } catch ( IllegalArgumentException iaE ) { ... }

Since:

11/5/2016

Version:

%I%

Author:

SPF , chip-nlp

Constructor Summary

Constructors

Constructor and Description
TimeoutMatcher(Pattern pattern, String text) Uses the default timeout of 1000 milliseconds
TimeoutMatcher(Pattern pattern, String text, int timeoutMillis) Uses the default timeout of 1000 milliseconds
TimeoutMatcher(String regex, String text) Uses the default timeout of 1000 milliseconds
TimeoutMatcher(String regex, String text, int timeoutMillis)

Method Summary

Modifier and Type	Method and Description
void	close() shut down the executor
Matcher	nextMatch()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeoutMatcher

public TimeoutMatcher(String regex,
                      String text)
               throws IllegalArgumentException

Uses the default timeout of 1000 milliseconds

Parameters:

regex - regular expression

text - text to parse

Throws:

IllegalArgumentException - if the regular expression is null or malformed

TimeoutMatcher

public TimeoutMatcher(String regex,
                      String text,
                      int timeoutMillis)
               throws IllegalArgumentException

Parameters:

regex - regular expression

text - text to parse

timeoutMillis - milliseconds at which the regex match should abort, between 100 and 10000

Throws:

IllegalArgumentException - if the regular expression is null or malformed

TimeoutMatcher

public TimeoutMatcher(Pattern pattern,
                      String text)
               throws IllegalArgumentException

Uses the default timeout of 1000 milliseconds

Parameters:

pattern - Pattern compiled from a regular expression

text - text to parse

Throws:

IllegalArgumentException - if the pattern is null or malformed

TimeoutMatcher

public TimeoutMatcher(Pattern pattern,
                      String text,
                      int timeoutMillis)
               throws IllegalArgumentException

Uses the default timeout of 1000 milliseconds

Parameters:

pattern - Pattern compiled from a regular expression

text - text to parse

timeoutMillis - milliseconds at which the regex match should abort, between 100 and 10000

Throws:

IllegalArgumentException - if the pattern is null or malformed

Method Detail

nextMatch

public Matcher nextMatch()

Returns:

a matcher representing the next call to Matcher.find()

close

public void close()

shut down the executor

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable