MatchRuleChars (PF-All 7.4.0 API)

java.lang.Object
- org.pfsw.text.MatchRuleChars

All Implemented Interfaces:

java.io.Serializable
```
public class MatchRuleChars
extends java.lang.Object
implements java.io.Serializable
```
Contains the set of special characters for MatchRules.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MatchRuleChars()
Initialize the new instance with default values.

Constructors
Constructor and Description
`MatchRuleChars()` Initialize the new instance with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`getAndChar()` Returns the character for AND operations ( DEFAULT = '&' )
`char`	`getEqualsChar()` Returns the character that is used to compare if two values are equal ( DEFAULT = '=' )
`char`	`getGreaterChar()` Returns the character that is used to compare if a value is greater than another ( DEFAULT = '>' )
`char`	`getGroupEndChar()` Returns the character that ends a logical group ( DEFAULT = ')' )
`char`	`getGroupStartChar()` Returns the character that starts a logical group ( DEFAULT = '(' )
`char`	`getLessChar()` Returns the character that is used to compare if a value is less than another ( DEFAULT = '<' )
`char`	`getMultiCharWildcard()` Returns the character that is used as placeholder for multiple characters.
`char`	`getNotChar()` Returns the character for NOT operations ( DEFAULT = '!' )
`char`	`getOrChar()` Returns the character for OR operations ( DEFAULT = '\|' )
`char`	`getSingleCharWildcard()` Returns the character that is used as placeholder for a single character.
`java.lang.String`	`getSpecialNameCharacters()` Returns all extra charcters, that are allowed in attribute names.
`char`	`getValueDelimiterChar()` Returns the character that is used to enclose a value ( DEFAULT = '\'' )
`char`	`getValueEndChar()` Returns the character ends a list of values ( DEFAULT = '}' )
`char`	`getValueSeparatorChar()` Returns the character for separation of values ( DEFAULT = ',' )
`char`	`getValueStartChar()` Returns the character that starts a list of values ( DEFAULT = '{' )
`void`	`reset()` Resets all rule characters to their default values.
`void`	`setAndChar(char newValue)` Sets the character for AND operations
`void`	`setEqualsChar(char newValue)` Sets the character that is used to compare if two values are equal
`void`	`setGreaterChar(char newValue)` Sets the character that is used to compare if a value is greater than another
`void`	`setGroupEndChar(char newValue)` Sets the character that ends a group
`void`	`setGroupStartChar(char newValue)` Sets the character that starts a group
`void`	`setLessChar(char newValue)` Sets the character that is used to compare if a value is less than another
`void`	`setNotChar(char newValue)` Sets the character for NOT operations
`void`	`setOrChar(char newValue)` Sets the character for OR operations
`void`	`setSpecialNameCharacters(java.lang.String chars)` Sets all extra charcters, that are allowed in attribute names.
`void`	`setValueDelimiterChar(char newValue)` Sets the character that is used to enclose a value
`void`	`setValueEndChar(char newValue)` Sets the character that ends a value list
`void`	`setValueSeparatorChar(char newValue)` Sets the character that separates values in a value list
`void`	`setValueStartChar(char newValue)` Sets the character that starts a value list

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

- Constructor Detail
  - MatchRuleChars
```
public MatchRuleChars()
```
    Initialize the new instance with default values.
- Method Detail
  - getSpecialNameCharacters
```
public java.lang.String getSpecialNameCharacters()
```
    Returns all extra charcters, that are allowed in attribute names.
    By default only [A-Z][a-z][0-9] are allowed.
  - setSpecialNameCharacters
```
public void setSpecialNameCharacters(java.lang.String chars)
```
    Sets all extra charcters, that are allowed in attribute names.
    By default only [A-Z][a-z][0-9] are allowed.
    
    Parameters:
    
    chars - All additional characters that are allowed in attribute names (must not be null)
  - getAndChar
```
public char getAndChar()
```
    Returns the character for AND operations ( DEFAULT = '&' )
  - setAndChar
```
public void setAndChar(char newValue)
```
    Sets the character for AND operations
  - getOrChar
```
public char getOrChar()
```
    Returns the character for OR operations ( DEFAULT = '|' )
  - setOrChar
```
public void setOrChar(char newValue)
```
    Sets the character for OR operations
  - getNotChar
```
public char getNotChar()
```
    Returns the character for NOT operations ( DEFAULT = '!' )
  - setNotChar
```
public void setNotChar(char newValue)
```
    Sets the character for NOT operations
  - getValueSeparatorChar
```
public char getValueSeparatorChar()
```
    Returns the character for separation of values ( DEFAULT = ',' )
  - setValueSeparatorChar
```
public void setValueSeparatorChar(char newValue)
```
    Sets the character that separates values in a value list
  - getValueStartChar
```
public char getValueStartChar()
```
    Returns the character that starts a list of values ( DEFAULT = '{' )
  - setValueStartChar
```
public void setValueStartChar(char newValue)
```
    Sets the character that starts a value list
  - getValueEndChar
```
public char getValueEndChar()
```
    Returns the character ends a list of values ( DEFAULT = '}' )
  - setValueEndChar
```
public void setValueEndChar(char newValue)
```
    Sets the character that ends a value list
  - getGroupStartChar
```
public char getGroupStartChar()
```
    Returns the character that starts a logical group ( DEFAULT = '(' )
  - setGroupStartChar
```
public void setGroupStartChar(char newValue)
```
    Sets the character that starts a group
  - getGroupEndChar
```
public char getGroupEndChar()
```
    Returns the character that ends a logical group ( DEFAULT = ')' )
  - setGroupEndChar
```
public void setGroupEndChar(char newValue)
```
    Sets the character that ends a group
  - getEqualsChar
```
public char getEqualsChar()
```
    Returns the character that is used to compare if two values are equal ( DEFAULT = '=' )
  - setEqualsChar
```
public void setEqualsChar(char newValue)
```
    Sets the character that is used to compare if two values are equal
  - getGreaterChar
```
public char getGreaterChar()
```
    Returns the character that is used to compare if a value is greater than another ( DEFAULT = '>' )
  - setGreaterChar
```
public void setGreaterChar(char newValue)
```
    Sets the character that is used to compare if a value is greater than another
  - getLessChar
```
public char getLessChar()
```
    Returns the character that is used to compare if a value is less than another ( DEFAULT = '<' )
  - setLessChar
```
public void setLessChar(char newValue)
```
    Sets the character that is used to compare if a value is less than another
  - getValueDelimiterChar
```
public char getValueDelimiterChar()
```
    Returns the character that is used to enclose a value ( DEFAULT = '\'' )
  - setValueDelimiterChar
```
public void setValueDelimiterChar(char newValue)
```
    Sets the character that is used to enclose a value
  - reset
```
public void reset()
```
    Resets all rule characters to their default values.
    That is:
    - & = AND
    - | = OR
    - ! = NOT
    - { = start of value(s)
    - , = value list separator
    - } = end of value(s)
    - ( = start of group
    - ) = end of group
    - = = equals operator
    - > = greater than operator
    - < = less than operator
    - ' = value delimiter
    It also resets the special characters in attributes names to none ("").
  - getMultiCharWildcard
```
public char getMultiCharWildcard()
```
    Returns the character that is used as placeholder for multiple characters. Currently that is '*'.
  - getSingleCharWildcard
```
public char getSingleCharWildcard()
```
    Returns the character that is used as placeholder for a single character. Currently that is '?'.

Class MatchRuleChars

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MatchRuleChars

Method Detail

getSpecialNameCharacters

setSpecialNameCharacters

getAndChar

setAndChar

getOrChar

setOrChar

getNotChar

setNotChar

getValueSeparatorChar

setValueSeparatorChar

getValueStartChar

setValueStartChar

getValueEndChar

setValueEndChar

getGroupStartChar

setGroupStartChar

getGroupEndChar

setGroupEndChar

getEqualsChar

setEqualsChar

getGreaterChar

setGreaterChar

getLessChar

setLessChar

getValueDelimiterChar

setValueDelimiterChar

reset

getMultiCharWildcard

getSingleCharWildcard