ReplaceRegexp (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.indexing.analysis.v10.DocumentProcessor
- - com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor
  - - com.exalead.indexing.analysis.v10.ReplaceRegexp

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class ReplaceRegexp
extends SingleContextDocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable
```
Substitutes the content substring of all DocumentChunks having the ContextName 'inputContext', using:
- 'pattern' as the matching substring regular expression
- and 'value' as the replacement value.
This value may have the form of sed output format using references to captures \0 through \9.
A new DocumentChunk is created with the substitutions.
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor
  SingleContextDocumentProcessor.Transformer<T>
- Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor
  DocumentProcessor.FromDataModel

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_REPLACE_ALL`
`java.lang.String`	`outputContext`
`java.lang.String`	`pattern`
`boolean`	`replaceAll`
`java.lang.String`	`value`

Fields inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor
inputContext

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor
acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors
Constructor and Description

ReplaceRegexp()

ReplaceRegexp(ReplaceRegexp o)
Copy constructor

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`accept(DocumentProcessor.Transformer<T> transformer, T[] t)`
`<T> T`	`accept(SingleContextDocumentProcessor.Transformer<T> transformer, T[] t)`
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this ReplaceRegexp.
`static ReplaceRegexp`	`fromString(java.lang.String s)` String representation of this ReplaceRegexp.
`java.lang.String`	`getOutputContext()` ContextName to be associated with the DocumentChunk created for each new context.
`java.lang.String`	`getPattern()` Pattern used to match the substrings to replace. ASTL library is used to perform regular expression matching. The regular expression language supported is Perl 5, WITHOUT support for: lazy (non-greedy) quantifiers like ?, +?, ??, {n}?, {n,}?, {n,m}? possessive quantifiers like +, ++, ?+, {n}+, {n,}+, {n,m}+ assertions like \b, \B, \A, \z, \Z, \G look-around assertions (?=pattern), (?!pattern), (?<=pattern), (?pattern) numeric and named backreferences like \1, \g1, g{-1}, \g{name}, k, k'name' named Unicode character \N{name} all operators related to Perl code inlining like (?{ code }) all operators related to backtracking algorithm control like independent subexpression (?>pattern) \C matching a single C char (octet) of the pattern-match modifiers (?pimsx-imsx) only (?i:pattern) and (?i) are supported (no negative form)
`java.lang.String`	`getValue()` The replacement value (sed-like output format).
`boolean`	`isReplaceAll()` Replaces all first occurrences of patterns.
`ReplaceRegexp`	`makeCopy()` Creates and returns a deep copy of this ReplaceRegexp.
`static ReplaceRegexp`	`readFrom(java.io.InputStream is)` Read this ReplaceRegexp from an XML fragment.
`void`	`setOutputContext(java.lang.String outputContext)` ContextName to be associated with the DocumentChunk created for each new context.
`void`	`setPattern(java.lang.String pattern)` Pattern used to match the substrings to replace. ASTL library is used to perform regular expression matching. The regular expression language supported is Perl 5, WITHOUT support for: lazy (non-greedy) quantifiers like ?, +?, ??, {n}?, {n,}?, {n,m}? possessive quantifiers like +, ++, ?+, {n}+, {n,}+, {n,m}+ assertions like \b, \B, \A, \z, \Z, \G look-around assertions (?=pattern), (?!pattern), (?<=pattern), (?pattern) numeric and named backreferences like \1, \g1, g{-1}, \g{name}, k, k'name' named Unicode character \N{name} all operators related to Perl code inlining like (?{ code }) all operators related to backtracking algorithm control like independent subexpression (?>pattern) \C matching a single C char (octet) of the pattern-match modifiers (?pimsx-imsx) only (?i:pattern) and (?i) are supported (no negative form)
`void`	`setReplaceAll(boolean replaceAll)` Replaces all first occurrences of patterns.
`void`	`setValue(java.lang.String value)` The replacement value (sed-like output format).
`java.lang.String`	`toString()` String representation of this ReplaceRegexp.
`ReplaceRegexp`	`withAcceptCondition(AcceptCondition acceptCondition)`
`ReplaceRegexp`	`withDataModelClass(java.lang.String dataModelClass)`
`ReplaceRegexp`	`withDataModelProperty(java.lang.String dataModelProperty)`
`ReplaceRegexp`	`withDataModelState(java.lang.String dataModelState)`
`ReplaceRegexp`	`withDisabled(boolean disabled)`
`ReplaceRegexp`	`withDisabled(java.lang.Boolean disabled)`
`ReplaceRegexp`	`withFromDataModel(DocumentProcessor fromDataModel)`
`ReplaceRegexp`	`withInputContext(java.lang.String inputContext)`
`ReplaceRegexp`	`withName(java.lang.String name)`
`ReplaceRegexp`	`withOutputContext(java.lang.String outputContext)`
`ReplaceRegexp`	`withPattern(java.lang.String pattern)`
`ReplaceRegexp`	`withReplaceAll(boolean replaceAll)`
`ReplaceRegexp`	`withReplaceAll(java.lang.Boolean replaceAll)`
`ReplaceRegexp`	`withValue(java.lang.String value)`
`void`	`writeTo(java.io.OutputStream os)` Write this ReplaceRegexp as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor
getInputContext, setInputContext

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor
getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

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

- Field Detail
  - outputContext
```
public java.lang.String outputContext
```
  - pattern
```
public java.lang.String pattern
```
  - value
```
public java.lang.String value
```
  - replaceAll
```
public boolean replaceAll
```
  - DEFAULT_REPLACE_ALL
```
public static final boolean DEFAULT_REPLACE_ALL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReplaceRegexp
```
public ReplaceRegexp()
```
  - ReplaceRegexp
```
public ReplaceRegexp(ReplaceRegexp o)
```
    Copy constructor
- Method Detail
  - withInputContext
```
public ReplaceRegexp withInputContext(java.lang.String inputContext)
```
    Overrides:
    
    withInputContext in class SingleContextDocumentProcessor
  - withAcceptCondition
```
public ReplaceRegexp withAcceptCondition(AcceptCondition acceptCondition)
```
    Overrides:
    
    withAcceptCondition in class SingleContextDocumentProcessor
  - withName
```
public ReplaceRegexp withName(java.lang.String name)
```
    Overrides:
    
    withName in class SingleContextDocumentProcessor
  - withDataModelState
```
public ReplaceRegexp withDataModelState(java.lang.String dataModelState)
```
    Overrides:
    
    withDataModelState in class SingleContextDocumentProcessor
  - withFromDataModel
```
public ReplaceRegexp withFromDataModel(DocumentProcessor fromDataModel)
```
    Overrides:
    
    withFromDataModel in class SingleContextDocumentProcessor
  - withDataModelClass
```
public ReplaceRegexp withDataModelClass(java.lang.String dataModelClass)
```
    Overrides:
    
    withDataModelClass in class SingleContextDocumentProcessor
  - withDataModelProperty
```
public ReplaceRegexp withDataModelProperty(java.lang.String dataModelProperty)
```
    Overrides:
    
    withDataModelProperty in class SingleContextDocumentProcessor
  - withDisabled
```
public ReplaceRegexp withDisabled(boolean disabled)
```
    Overrides:
    
    withDisabled in class SingleContextDocumentProcessor
  - withDisabled
```
public ReplaceRegexp withDisabled(java.lang.Boolean disabled)
```
    Overrides:
    
    withDisabled in class SingleContextDocumentProcessor
  - setOutputContext
```
public void setOutputContext(java.lang.String outputContext)
```
    ContextName to be associated with the DocumentChunk created for each new context.
  - getOutputContext
```
public java.lang.String getOutputContext()
```
    ContextName to be associated with the DocumentChunk created for each new context.
  - withOutputContext
```
public ReplaceRegexp withOutputContext(java.lang.String outputContext)
```
  - setPattern
```
public void setPattern(java.lang.String pattern)
```
    Pattern used to match the substrings to replace.
    ASTL library is used to perform regular expression matching.
    The regular expression language supported is Perl 5, WITHOUT support for:
    - lazy (non-greedy) quantifiers like *?, +?, ??, {n}?, {n,}?, {n,m}?
    - possessive quantifiers like *+, ++, ?+, {n}+, {n,}+, {n,m}+
    - assertions like \b, \B, \A, \z, \Z, \G
    - look-around assertions (?=pattern), (?!pattern), (?<=pattern), (?
    - named captures (?'name'pattern), (?pattern)
    - numeric and named backreferences like \1, \g1, g{-1}, \g{name}, k, k'name'
    - named Unicode character \N{name}
    - all operators related to Perl code inlining like (?{ code })
    - all operators related to backtracking algorithm control like independent subexpression (?>pattern)
    - \C matching a single C char (octet)
    - of the pattern-match modifiers (?pimsx-imsx) only (?i:pattern) and (?i) are supported (no negative form)
  - getPattern
```
public java.lang.String getPattern()
```
    Pattern used to match the substrings to replace.
    ASTL library is used to perform regular expression matching.
    The regular expression language supported is Perl 5, WITHOUT support for:
    - lazy (non-greedy) quantifiers like *?, +?, ??, {n}?, {n,}?, {n,m}?
    - possessive quantifiers like *+, ++, ?+, {n}+, {n,}+, {n,m}+
    - assertions like \b, \B, \A, \z, \Z, \G
    - look-around assertions (?=pattern), (?!pattern), (?<=pattern), (?
    - named captures (?'name'pattern), (?pattern)
    - numeric and named backreferences like \1, \g1, g{-1}, \g{name}, k, k'name'
    - named Unicode character \N{name}
    - all operators related to Perl code inlining like (?{ code })
    - all operators related to backtracking algorithm control like independent subexpression (?>pattern)
    - \C matching a single C char (octet)
    - of the pattern-match modifiers (?pimsx-imsx) only (?i:pattern) and (?i) are supported (no negative form)
  - withPattern
```
public ReplaceRegexp withPattern(java.lang.String pattern)
```
  - setValue
```
public void setValue(java.lang.String value)
```
    The replacement value (sed-like output format).
  - getValue
```
public java.lang.String getValue()
```
    The replacement value (sed-like output format).
  - withValue
```
public ReplaceRegexp withValue(java.lang.String value)
```
  - setReplaceAll
```
public void setReplaceAll(boolean replaceAll)
```
    Replaces all first occurrences of patterns.
  - isReplaceAll
```
public boolean isReplaceAll()
```
    Replaces all first occurrences of patterns.
  - withReplaceAll
```
public ReplaceRegexp withReplaceAll(boolean replaceAll)
```
  - withReplaceAll
```
public ReplaceRegexp withReplaceAll(java.lang.Boolean replaceAll)
```
  - makeCopy
```
public ReplaceRegexp makeCopy()
```
    Creates and returns a deep copy of this ReplaceRegexp.
    
    Overrides:
    
    makeCopy in class SingleContextDocumentProcessor
  - readFrom
```
public static ReplaceRegexp readFrom(java.io.InputStream is)
                              throws javax.xml.bind.JAXBException
```
    Read this ReplaceRegexp 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 ReplaceRegexp as an XML fragment
    
    Overrides:
    
    writeTo in class SingleContextDocumentProcessor
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static ReplaceRegexp fromString(java.lang.String s)
                                throws javax.xml.bind.JAXBException,
                                       java.io.UnsupportedEncodingException
```
    String representation of this ReplaceRegexp.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this ReplaceRegexp.
    
    Overrides:
    
    toString in class SingleContextDocumentProcessor
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this ReplaceRegexp.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Overrides:
    
    check in class SingleContextDocumentProcessor
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public <T> T accept(SingleContextDocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class SingleContextDocumentProcessor
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public <T> T accept(DocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class DocumentProcessor
    
    Throws:
    
    com.exalead.util.TypedException

Class ReplaceRegexp

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

Field Summary

Fields inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

Constructor Summary

Method Summary

Methods inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

Methods inherited from class java.lang.Object

Field Detail

outputContext

pattern

value

replaceAll

DEFAULT_REPLACE_ALL

Constructor Detail

ReplaceRegexp

ReplaceRegexp

Method Detail

withInputContext

withAcceptCondition

withName

withDataModelState

withFromDataModel

withDataModelClass

withDataModelProperty

withDisabled

withDisabled

setOutputContext

getOutputContext

withOutputContext

setPattern

getPattern

withPattern

setValue

getValue

withValue

setReplaceAll

isReplaceAll

withReplaceAll

withReplaceAll

makeCopy

readFrom

writeTo

fromString

toString

check

accept

accept