org.apache.ctakes.core.util.regex

Class RegexSpanFinder

java.lang.Object

org.apache.ctakes.core.util.regex.RegexSpanFinder

All Implemented Interfaces:

Closeable, AutoCloseable

public final class RegexSpanFinder
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.

Proper usage is: try ( RegexSpanFinder finder = new RegexSpanFinder( "\\s+" ) ) { final List> spans = finder.findSpans( "Hello World !" ); ... } catch ( IllegalArgumentException iaE ) { ... }

Since:

11/5/2016

Version:

%I%

Author:

SPF , chip-nlp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() shut down the executor
List<Pair<Integer>>	findSpans(String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexSpanFinder

public RegexSpanFinder(String regex)
                throws IllegalArgumentException

Uses the default timeout of 1000 milliseconds

Parameters:

regex - regular expression

Throws:

IllegalArgumentException - if the regular expression is null or malformed

RegexSpanFinder

public RegexSpanFinder(String regex,
                       int timeoutMillis)
                throws IllegalArgumentException

Parameters:

regex - regular expression

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

Throws:

IllegalArgumentException - if the regular expression is null or malformed

RegexSpanFinder

public RegexSpanFinder(Pattern pattern)
                throws IllegalArgumentException

Uses the default timeout of 1000 milliseconds

Parameters:

pattern - Pattern compiled from a regular expression

Throws:

IllegalArgumentException - if the pattern is null or malformed

RegexSpanFinder

public RegexSpanFinder(Pattern pattern,
                       int timeoutMillis)
                throws IllegalArgumentException

Uses the default timeout of 1000 milliseconds

Parameters:

pattern - Pattern compiled from a regular expression

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

Throws:

IllegalArgumentException - if the pattern is null or malformed

Method Detail

findSpans

public List<Pair<Integer>> findSpans(String text)

Parameters:

text - text in which a find should be conducted

Returns:

List of Integer Pairs representing text span begin and end offsets

close

public void close()

shut down the executor

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable