Rule (Okapi Framework SDK 1.43.0 API)

java.lang.Object
- net.sf.okapi.filters.regex.Rule

```
public class Rule
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected InlineCodeFinder`	`codeFinder`
`protected String`	`expr`
`protected int`	`nameGroup`
`protected int`	`noteGroup`
`protected Pattern`	`pattern`
`protected boolean`	`preserveWS`
`protected String`	`propertyName`
`protected String`	`propertyValue`
`protected String`	`ruleName`
`protected int`	`ruleType`
`static int`	`RULETYPE_CLOSEGROUP`
`static int`	`RULETYPE_COMMENT`
`static int`	`RULETYPE_CONTENT`
`static int`	`RULETYPE_NOTRANS`
`static int`	`RULETYPE_OPENGROUP`
`static int`	`RULETYPE_STRING`
`protected String`	`sample`
`protected int`	`sourceGroup`
`protected int`	`targetGroup`
`protected boolean`	`useCodeFinder`

Constructor Summary

Constructors
Constructor and Description

Rule()

Rule(Rule obj)

Constructors
Constructor and Description
`Rule()`
`Rule(Rule obj)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`fromString(String data)`
`String`	`getCodeFinderRules()`
`String`	`getExpression()`
`int`	`getNameGroup()`
`int`	`getNoteGroup()`
`String`	`getPropertyName()`
`String`	`getPropertyValue()`
`String`	`getRuleName()`
`int`	`getRuleType()`
`String`	`getSample()`
`int`	`getSourceGroup()`
`int`	`getTargetGroup()`
`boolean`	`preserveWS()`
`void`	`setCodeFinderRules(String value)`
`void`	`setExpression(String value)`
`void`	`setNameGroup(int index)`
`void`	`setNoteGroup(int index)`
`void`	`setPreserveWS(boolean value)`
`void`	`setPropertyName(String value)`
`void`	`setPropertyValue(String value)`
`void`	`setRuleName(String value)`
`void`	`setRuleType(int value)`
`void`	`setSample(String value)`
`void`	`setSourceGroup(int index)`
`void`	`setTargetGroup(int index)`
`void`	`setUseCodeFinder(boolean value)`
`String`	`toString()`
`boolean`	`useCodeFinder()`

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

Field Detail

RULETYPE_STRING
```
public static final int RULETYPE_STRING
```
See Also:

Constant Field Values

RULETYPE_CONTENT
```
public static final int RULETYPE_CONTENT
```
See Also:

Constant Field Values

RULETYPE_COMMENT
```
public static final int RULETYPE_COMMENT
```
See Also:

Constant Field Values

RULETYPE_NOTRANS
```
public static final int RULETYPE_NOTRANS
```
See Also:

Constant Field Values

RULETYPE_OPENGROUP
```
public static final int RULETYPE_OPENGROUP
```
See Also:

Constant Field Values

RULETYPE_CLOSEGROUP
```
public static final int RULETYPE_CLOSEGROUP
```
See Also:

Constant Field Values

ruleName
```
protected String ruleName
```

expr
```
protected String expr
```

ruleType
```
protected int ruleType
```

preserveWS
```
protected boolean preserveWS
```

useCodeFinder
```
protected boolean useCodeFinder
```

codeFinder
```
protected InlineCodeFinder codeFinder
```

propertyName
```
protected String propertyName
```

propertyValue
```
protected String propertyValue
```

sample
```
protected String sample
```

sourceGroup
```
protected int sourceGroup
```

targetGroup
```
protected int targetGroup
```

nameGroup
```
protected int nameGroup
```

noteGroup
```
protected int noteGroup
```

pattern
```
protected Pattern pattern
```

Constructor Detail
- Rule
```
public Rule()
```
- Rule
```
public Rule(Rule obj)
```

Method Detail

getRuleName
```
public String getRuleName()
```

setRuleName

public void setRuleName(String value)

getExpression
```
public String getExpression()
```

setExpression

public void setExpression(String value)

getSample
```
public String getSample()
```

setSample
```
public void setSample(String value)
```

getRuleType
```
public int getRuleType()
```

setRuleType
```
public void setRuleType(int value)
```

getSourceGroup
```
public int getSourceGroup()
```

setSourceGroup

public void setSourceGroup(int index)

getTargetGroup
```
public int getTargetGroup()
```

setTargetGroup

public void setTargetGroup(int index)

getNameGroup
```
public int getNameGroup()
```

setNameGroup
```
public void setNameGroup(int index)
```

getNoteGroup
```
public int getNoteGroup()
```

setNoteGroup
```
public void setNoteGroup(int index)
```

preserveWS
```
public boolean preserveWS()
```

setPreserveWS

public void setPreserveWS(boolean value)

getPropertyName
```
public String getPropertyName()
```

setPropertyName

public void setPropertyName(String value)

getPropertyValue
```
public String getPropertyValue()
```

setPropertyValue

public void setPropertyValue(String value)

useCodeFinder
```
public boolean useCodeFinder()
```

setUseCodeFinder

public void setUseCodeFinder(boolean value)

getCodeFinderRules
```
public String getCodeFinderRules()
```

setCodeFinderRules

public void setCodeFinderRules(String value)

toString
```
public String toString()
```
Overrides:

toString in class Object

fromString
```
public void fromString(String data)
```

Class Rule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RULETYPE_STRING

RULETYPE_CONTENT

RULETYPE_COMMENT

RULETYPE_NOTRANS

RULETYPE_OPENGROUP

RULETYPE_CLOSEGROUP

ruleName

expr

ruleType

preserveWS

useCodeFinder

codeFinder

propertyName

propertyValue

sample

sourceGroup

targetGroup

nameGroup

noteGroup

pattern

Constructor Detail

Rule

Rule

Method Detail

getRuleName

setRuleName

getExpression

setExpression

getSample

setSample

getRuleType

setRuleType

getSourceGroup

setSourceGroup

getTargetGroup

setTargetGroup

getNameGroup

setNameGroup

getNoteGroup

setNoteGroup

preserveWS

setPreserveWS

getPropertyName

setPropertyName

getPropertyValue

setPropertyValue

useCodeFinder

setUseCodeFinder

getCodeFinderRules

setCodeFinderRules

toString

fromString