package-info.java

/**
 * This package contains a library, TokensRegex, for matching regular expressions over
 * tokens.  TokensRegex is incorporated into the
 * {@link edu.stanford.nlp.pipeline.TokensRegexAnnotator},
 * the {@link edu.stanford.nlp.pipeline.TokensRegexNERAnnotator},
 * and the SUTime functionality in {@link edu.stanford.nlp.pipeline.NERCombinerAnnotator}.
 *
 * <h3>Rules for extracting expression using TokensRegex</h3>
 *
 * <p>TokensRegex provides a language for specifying rules to extract expressions over a token sequence.</p>
 * <p>{@link edu.stanford.nlp.ling.tokensregex.CoreMapExpressionExtractor} and
 * {@link edu.stanford.nlp.ling.tokensregex.SequenceMatchRules} describes
 * the language and how the extraction rules are created.</p>
 *
 * <h3>Core classes for token sequence matching using TokensRegex</h3>
 *
 * <p>At the core of TokensRegex are the
 * {@link edu.stanford.nlp.ling.tokensregex.TokenSequenceMatcher} and
 * {@link edu.stanford.nlp.ling.tokensregex.TokenSequencePattern} classes which
 * can be used to match patterns over a sequences of tokens.
 * The usage is designed to follow the paradigm of the Java regular expression library
 * {@code java.util.regex}.  The usage is similar except that matches are done
 * over {@code List<CoreMap>} instead of over {@code String}.
 * </p>
 * <p>Example:</p>
 * <pre> {@code List<CoreLabel> tokens = ...;
 * TokenSequencePattern pattern = TokenSequencePattern.compile(...);
 * TokenSequenceMatcher matcher = pattern.getMatcher(tokens);
 * }</pre>
 * <p>The classes {@link edu.stanford.nlp.ling.tokensregex.SequenceMatcher} and
 * {@link edu.stanford.nlp.ling.tokensregex.SequencePattern} can be used to build
 * classes for recognizing regular expressions over sequences of arbitrary types.</p>
 *
 * <h3>Utility classes</h3>
 *
 * <p>TokensRegex also offers a group of utility classes.</p>
 * <p>
 * {@link edu.stanford.nlp.ling.tokensregex.MultiPatternMatcher} provides utility functions for
 * finding expressions with multiple patterns.
 * For instance, using {@link edu.stanford.nlp.ling.tokensregex.MultiPatternMatcher#findNonOverlapping}
 * you can find all nonoverlapping subsequences for a given set of patterns.
 * </p>
 * <p>To find character offsets of multiple word expressions in a {@code String},
 * you can also use
 * {@link edu.stanford.nlp.ling.tokensregex.MultiWordStringMatcher#findTargetStringOffsets}.
 * </p>
 *
 * @author Angel Chang (angelx@stanford.edu)
 */
package edu.stanford.nlp.ling.tokensregex;