element <bot:pattern>

Namespace:	http://www.zionsoftware.com/jbuddy/bot
Type:	embedded (extension of bot:pattern)
Content:	empty, 9 attributes
Defined:	locally at 1 location

XML Representation Summary
<bot:pattern
	canonEq	=	boolean
	caseInsensitive	=	boolean
	comments	=	boolean
	dotall	=	boolean
	literal	=	boolean
	multiline	=	boolean
	type	=	("protocol" \| "client" \| "user" \| "status" \| "statusMessage" \| "messageType" \| "message")
	unicodeCase	=	boolean
	unixLines	=	boolean
/>

May be included in elements (2):

bot:exclude (type bot:filter),

bot:include (type bot:filter)

Usage / Definition Locations

Within global complexTypes (1):
bot:filter [def]

Annotation

A pattern used to match various properties of an event.

Embedded Type Detail

Type Derivation Summary

The following documentation was copied from the Java 2 Platform SE 5.0 API documentation.

Enables canonical equivalence.

When this flag is specified then two characters will be considered to match if, and only if, their full canonical decompositions match. The expression "a\u030A", for example, will match the string "å" when this flag is specified. By default, matching does not take canonical equivalence into account.

There is no embedded flag character for enabling canonical equivalence.

Specifying this flag may impose a performance penalty.

Type:	boolean
Use:	optional
Defined:	locally, within bot:pattern complexType

caseInsensitive

The following documentation was copied from the Java 2 Platform SE 5.0 API documentation.

Enables case-insensitive matching.

By default, case-insensitive matching assumes that only characters in the US-ASCII charset are being matched. Unicode-aware case-insensitive matching can be enabled by specifying the unicodeCase flag in conjunction with this flag.

Case-insensitive matching can also be enabled via the embedded flag expression (?i).

Specifying this flag may impose a slight performance penalty.

Type:	boolean
Use:	optional
Defined:	locally, within bot:pattern complexType

comments

The following documentation was copied from the Java 2 Platform SE 5.0 API documentation.

Permits whitespace and comments in pattern.

In this mode, whitespace is ignored, and embedded comments starting with # are ignored until the end of a line.

Comments mode can also be enabled via the embedded flag expression (?x).

Type:	boolean
Use:	optional
Defined:	locally, within bot:pattern complexType

dotall

The following documentation was copied from the Java 2 Platform SE 5.0 API documentation.

Enables dotall mode.

In dotall mode, the expression . matches any character, including a line terminator. By default this expression does not match line terminators.

Dotall mode can also be enabled via the embedded flag expression (?s). (The s is a mnemonic for "single-line" mode, which is what this is called in Perl.)

Type:	boolean
Use:	optional
Defined:	locally, within bot:pattern complexType

literal

The following documentation was copied from the Java 2 Platform SE 5.0 API documentation.

Enables literal parsing of the pattern.

When this flag is specified then the input string that specifies the pattern is treated as a sequence of literal characters. Metacharacters or escape sequences in the input sequence will be given no special meaning.

The flags caseInsensitive and unicodeCase retain their impact on matching when used in conjunction with this flag. The other flags become superfluous.

There is no embedded flag character for enabling literal parsing.

Type:	boolean
Use:	optional
Defined:	locally, within bot:pattern complexType

multiline

The following documentation was copied from the Java 2 Platform SE 5.0 API documentation.

Enables multiline mode.

In multiline mode the expressions ^ and $ match just after or just before, respectively, a line terminator or the end of the input sequence. By default these expressions only match at the beginning and the end of the entire input sequence.

Multiline mode can also be enabled via the embedded flag expression (?m).

Type:	boolean
Use:	optional
Defined:	locally, within bot:pattern complexType

type

Sets this pattern's type.

Type:	bot:filterPatternType
Use:	required
Defined:	locally, within this element

unicodeCase

The following documentation was copied from the Java 2 Platform SE 5.0 API documentation.

Enables Unicode-aware case folding.

When this flag is specified then case-insensitive matching, when enabled by the caseInsensitive flag, is done in a manner consistent with the Unicode Standard. By default, case-insensitive matching assumes that only characters in the US-ASCII charset are being matched.

Unicode-aware case folding can also be enabled via the embedded flag expression (?u).

Specifying this flag may impose a performance penalty.

Type:	boolean
Use:	optional
Defined:	locally, within bot:pattern complexType

unixLines

The following documentation was copied from the Java 2 Platform SE 5.0 API documentation.

Enables Unix lines mode.

In this mode, only the '\n' line terminator is recognized in the behavior of ., ^, and $.

Unix lines mode can also be enabled via the embedded flag expression (?d).

Type:	boolean
Use:	optional
Defined:	locally, within bot:pattern complexType

XML Schema documentation generated with DocFlex/XML (Kit) v1.6.0

DocFlex/XML is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else!

Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task!

Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com