RegexpMatcher (EXALEAD CloudView Custom code SDK)

java.lang.Object
- com.exalead.linguistic.v10.SemanticProcessor
- - com.exalead.linguistic.v10.RegexpMatcher

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class RegexpMatcher
extends SemanticProcessor
implements com.exalead.util.Checkable, java.io.Serializable
```
Matches a set of Perl-5 regular expressions, possibly capturing subparts of matches.
Use it for information extraction based on the text form like identifiers, emails or dates.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.exalead.linguistic.v10.SemanticProcessor
  SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`annotationTagsToReserve`
`static boolean`	`DEFAULT_LEFTMOST_LONGEST_MATCHING_POLICY`
`static boolean`	`DEFAULT_MATCH_SEP_SPACE`
`static int`	`DEFAULT_WINDOW_LENGTH`
`boolean`	`leftmostLongestMatchingPolicy`
`boolean`	`matchSepSpace`
`java.lang.String`	`resourceFile`
`int`	`windowLength`

Fields inherited from class com.exalead.linguistic.v10.SemanticProcessor
contexts, name, src

Constructor Summary

Constructors
Constructor and Description

RegexpMatcher()

RegexpMatcher(RegexpMatcher o)
Copy constructor

Constructors
Constructor and Description
`RegexpMatcher()`
`RegexpMatcher(RegexpMatcher o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T> T`	`accept(SemanticProcessor.Transformer<T> transformer, T[] t)`
`void`	`accept(SemanticProcessor.Visitor visitor)`
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this RegexpMatcher.
`static RegexpMatcher`	`fromString(java.lang.String s)` String representation of this RegexpMatcher.
`java.lang.String`	`getAnnotationTagsToReserve()` Annotation tags to reserve, in addition to the tags specified in the resource file This is useful if the regexps are to be updated on an already instantiated regexp matcher.
`java.lang.String`	`getResourceFile()` URL to the configuration file
`int`	`getWindowLength()` Length of the token window.
`boolean`	`isLeftmostLongestMatchingPolicy()` If true, apply a classical leftmost-longest selection on overlapping matches.
`boolean`	`isMatchSepSpace()` If true, allows a pattern to match text spans which contain space separators.
`RegexpMatcher`	`makeCopy()` Creates and returns a deep copy of this RegexpMatcher.
`static RegexpMatcher`	`readFrom(java.io.InputStream is)` Read this RegexpMatcher from an XML fragment.
`void`	`setAnnotationTagsToReserve(java.lang.String annotationTagsToReserve)` Annotation tags to reserve, in addition to the tags specified in the resource file This is useful if the regexps are to be updated on an already instantiated regexp matcher.
`void`	`setLeftmostLongestMatchingPolicy(boolean leftmostLongestMatchingPolicy)` If true, apply a classical leftmost-longest selection on overlapping matches.
`void`	`setMatchSepSpace(boolean matchSepSpace)` If true, allows a pattern to match text spans which contain space separators.
`void`	`setResourceFile(java.lang.String resourceFile)` URL to the configuration file
`void`	`setWindowLength(int windowLength)` Length of the token window.
`java.lang.String`	`toString()` String representation of this RegexpMatcher.
`RegexpMatcher`	`withAnnotationTagsToReserve(java.lang.String annotationTagsToReserve)`
`RegexpMatcher`	`withContexts(java.lang.String contexts)`
`RegexpMatcher`	`withLeftmostLongestMatchingPolicy(boolean leftmostLongestMatchingPolicy)`
`RegexpMatcher`	`withLeftmostLongestMatchingPolicy(java.lang.Boolean leftmostLongestMatchingPolicy)`
`RegexpMatcher`	`withMatchSepSpace(boolean matchSepSpace)`
`RegexpMatcher`	`withMatchSepSpace(java.lang.Boolean matchSepSpace)`
`RegexpMatcher`	`withName(java.lang.String name)`
`RegexpMatcher`	`withResourceFile(java.lang.String resourceFile)`
`RegexpMatcher`	`withSrc(java.lang.String src)` Deprecated.
`RegexpMatcher`	`withWindowLength(int windowLength)`
`RegexpMatcher`	`withWindowLength(java.lang.Integer windowLength)`
`void`	`writeTo(java.io.OutputStream os)` Write this RegexpMatcher as an XML fragment

Methods inherited from class com.exalead.linguistic.v10.SemanticProcessor
getContexts, getName, getSrc, setContexts, setName, setSrc

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - resourceFile
```
public java.lang.String resourceFile
```
  - annotationTagsToReserve
```
public java.lang.String annotationTagsToReserve
```
  - windowLength
```
public int windowLength
```
  - DEFAULT_WINDOW_LENGTH
```
public static final int DEFAULT_WINDOW_LENGTH
```
    See Also:
    
    Constant Field Values
  - leftmostLongestMatchingPolicy
```
public boolean leftmostLongestMatchingPolicy
```
  - DEFAULT_LEFTMOST_LONGEST_MATCHING_POLICY
```
public static final boolean DEFAULT_LEFTMOST_LONGEST_MATCHING_POLICY
```
    See Also:
    
    Constant Field Values
  - matchSepSpace
```
public boolean matchSepSpace
```
  - DEFAULT_MATCH_SEP_SPACE
```
public static final boolean DEFAULT_MATCH_SEP_SPACE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RegexpMatcher
```
public RegexpMatcher()
```
  - RegexpMatcher
```
public RegexpMatcher(RegexpMatcher o)
```
    Copy constructor
- Method Detail
  - withName
```
public RegexpMatcher withName(java.lang.String name)
```
    Overrides:
    
    withName in class SemanticProcessor
  - withContexts
```
public RegexpMatcher withContexts(java.lang.String contexts)
```
    Overrides:
    
    withContexts in class SemanticProcessor
  - withSrc
```
@Deprecated
public RegexpMatcher withSrc(java.lang.String src)
```
    Deprecated.
    
    Overrides:
    
    withSrc in class SemanticProcessor
  - setResourceFile
```
public void setResourceFile(java.lang.String resourceFile)
```
    URL to the configuration file
  - getResourceFile
```
public java.lang.String getResourceFile()
```
    URL to the configuration file
  - withResourceFile
```
public RegexpMatcher withResourceFile(java.lang.String resourceFile)
```
  - setAnnotationTagsToReserve
```
public void setAnnotationTagsToReserve(java.lang.String annotationTagsToReserve)
```
    Annotation tags to reserve, in addition to the tags specified in the resource file
    This is useful if the regexps are to be updated on an already instantiated regexp matcher.
  - getAnnotationTagsToReserve
```
public java.lang.String getAnnotationTagsToReserve()
```
    Annotation tags to reserve, in addition to the tags specified in the resource file
    This is useful if the regexps are to be updated on an already instantiated regexp matcher.
  - withAnnotationTagsToReserve
```
public RegexpMatcher withAnnotationTagsToReserve(java.lang.String annotationTagsToReserve)
```
  - setWindowLength
```
public void setWindowLength(int windowLength)
```
    Length of the token window. This is the maximum number of token a match can spread on.
    To match regexps on single tokens, use a window length of 1.
  - getWindowLength
```
public int getWindowLength()
```
    Length of the token window. This is the maximum number of token a match can spread on.
    To match regexps on single tokens, use a window length of 1.
  - withWindowLength
```
public RegexpMatcher withWindowLength(int windowLength)
```
  - withWindowLength
```
public RegexpMatcher withWindowLength(java.lang.Integer windowLength)
```
  - setLeftmostLongestMatchingPolicy
```
public void setLeftmostLongestMatchingPolicy(boolean leftmostLongestMatchingPolicy)
```
    If true, apply a classical leftmost-longest selection on overlapping matches. Otherwise, all matches are reported.
  - isLeftmostLongestMatchingPolicy
```
public boolean isLeftmostLongestMatchingPolicy()
```
    If true, apply a classical leftmost-longest selection on overlapping matches. Otherwise, all matches are reported.
  - withLeftmostLongestMatchingPolicy
```
public RegexpMatcher withLeftmostLongestMatchingPolicy(boolean leftmostLongestMatchingPolicy)
```
  - withLeftmostLongestMatchingPolicy
```
public RegexpMatcher withLeftmostLongestMatchingPolicy(java.lang.Boolean leftmostLongestMatchingPolicy)
```
  - setMatchSepSpace
```
public void setMatchSepSpace(boolean matchSepSpace)
```
    If true, allows a pattern to match text spans which contain space separators.
  - isMatchSepSpace
```
public boolean isMatchSepSpace()
```
    If true, allows a pattern to match text spans which contain space separators.
  - withMatchSepSpace
```
public RegexpMatcher withMatchSepSpace(boolean matchSepSpace)
```
  - withMatchSepSpace
```
public RegexpMatcher withMatchSepSpace(java.lang.Boolean matchSepSpace)
```
  - makeCopy
```
public RegexpMatcher makeCopy()
```
    Creates and returns a deep copy of this RegexpMatcher.
    
    Overrides:
    
    makeCopy in class SemanticProcessor
  - readFrom
```
public static RegexpMatcher readFrom(java.io.InputStream is)
                              throws javax.xml.bind.JAXBException
```
    Read this RegexpMatcher from an XML fragment.
    
    Throws:
    
    javax.xml.bind.JAXBException
  - writeTo
```
public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException
```
    Write this RegexpMatcher as an XML fragment
    
    Overrides:
    
    writeTo in class SemanticProcessor
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static RegexpMatcher fromString(java.lang.String s)
                                throws javax.xml.bind.JAXBException,
                                       java.io.UnsupportedEncodingException
```
    String representation of this RegexpMatcher.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this RegexpMatcher.
    
    Overrides:
    
    toString in class SemanticProcessor
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this RegexpMatcher.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Overrides:
    
    check in class SemanticProcessor
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public void accept(SemanticProcessor.Visitor visitor)
            throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class SemanticProcessor
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public <T> T accept(SemanticProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class SemanticProcessor
    
    Throws:
    
    com.exalead.util.TypedException

Class RegexpMatcher

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.linguistic.v10.SemanticProcessor

Field Summary

Fields inherited from class com.exalead.linguistic.v10.SemanticProcessor

Constructor Summary

Method Summary

Methods inherited from class com.exalead.linguistic.v10.SemanticProcessor

Methods inherited from class java.lang.Object

Field Detail

resourceFile

annotationTagsToReserve

windowLength

DEFAULT_WINDOW_LENGTH

leftmostLongestMatchingPolicy

DEFAULT_LEFTMOST_LONGEST_MATCHING_POLICY

matchSepSpace

DEFAULT_MATCH_SEP_SPACE

Constructor Detail

RegexpMatcher

RegexpMatcher

Method Detail

withName

withContexts

withSrc

setResourceFile

getResourceFile

withResourceFile

setAnnotationTagsToReserve

getAnnotationTagsToReserve

withAnnotationTagsToReserve

setWindowLength

getWindowLength

withWindowLength

withWindowLength

setLeftmostLongestMatchingPolicy

isLeftmostLongestMatchingPolicy

withLeftmostLongestMatchingPolicy

withLeftmostLongestMatchingPolicy

setMatchSepSpace

isMatchSepSpace

withMatchSepSpace

withMatchSepSpace

makeCopy

readFrom

writeTo

fromString

toString

check

accept

accept