oracle.javatools.db.token

Class TokenPattern<T extends Token>

java.lang.Object

oracle.javatools.db.token.TokenPattern<T>

Direct Known Subclasses:

PlSqlTokenPattern

public class TokenPattern<T extends Token>
extends java.lang.Object

TokenPattern works in collaboration with the Tokenizerto provide a search mechanism for Tokens (typically of SQL or PL/SQL).

Searches are applied using a regular expression like syntax, and applied only to the code, ignoring whitespace and comments.

Token Pattern Syntax
A token pattern expression is made up of one or more token clauses, where a token clause is defined as one of the following:

• Token Clause Sequence. One or more token clauses that must match in order.
• Token Clause Options. One or more token clauses enclosed in braces and seperated by vertical bar where only one clause needs to match. For example { clause1 | clause2 | clause3 }.
• Optional Token Clause. A token clause enclosed in brackets which is optional. For example [ clause1 ]
• Repeating Token Clause. A token clause followed by ellipses ( ... ) which may match one or more times.
• Inverted Token Clause. A token clause enclosed by braces and immediately preceded by a caret which must not match. For examlple {^ clause1 }.
• Parentheses Clause. This takes the form ( -- ), or other opening and closing tokens are also supported (which may need escaping, seebelow), eg \[--\], \<--\> and \{--\}. (For backward compatibility, "(...)" is equivalent to "(--)").
• A token. A token is any string literal, or one of the wildcards described below. The token will match ignoring case unless it is a string (surrounded by single or double quotes)

Wildcards

• A question mark ( ? ) can be placed in the expression, and this will match any single token.
• ?. will match any dot seperated list of tokens

Named Clauses
The results of any part of a match can be queried by naming search clauses within the overall expression. This is done by preceding the search clause with the required name and enclosing the name and clause with < and > For example "procedure <name ?.>" would be found in both

create or replace procedure updateSalary is...

and

create or replace procedure hr.updateSalary is...

the value of name in the first case being UPDATESALARY and in the second HR.UPDATESALARY. See getNamedMatch(String name, boolean format) for details.

Escaping Characters
Any of the special syntax characters <>[]{}| can be escaped with a single backslash. If you need to explicitly search for any number of backslashes preceding a special character then place a space between them - for example "\\ <name>".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TokenPattern.PatternResult The results of a test of a sequence of Tokens against a TokenPattern.

Constructor Summary

Constructors

Constructor and Description
TokenPattern(java.lang.String expression) Constructs a TokenPattern with the given expression.

Method Summary

Modifier and Type	Method and Description
protected Tokenizer.Config	getConfig(java.lang.String expression)
java.lang.String[]	getNames()
TokenPattern.PatternResult	getResult(java.lang.String source) Tokenizes the given source and attempts a pattern match from the first token.
TokenPattern.PatternResult	getResult(java.lang.String source, boolean startsWith) Tokenizes the given source and attempts a pattern match from the first token, optionally scanning until a match is found if startsWith == false.
TokenPattern.PatternResult	getResult(T startTk) Attempts a pattern match from the given token.
TokenPattern.PatternResult	getResult(T startTk, boolean startsWith) Attempts a pattern match from the given token, optionally scanning until a match is found if startsWith == false.
TokenPattern.PatternResult	getResult(T startTk, T endTk) Attempts a pattern match from the given start token, upto the given end token.
TokenPattern.PatternResult	getResult(T startTk, T endTk, boolean startsWith) Attempts a pattern match from the given token, upto the given end token, optionally scanning until a match is found if startsWith == false.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TokenPattern

public TokenPattern(java.lang.String expression)

Constructs a TokenPattern with the given expression.

Parameters:

expression -

Method Detail

getConfig

protected Tokenizer.Config getConfig(java.lang.String expression)

getNames

public java.lang.String[] getNames()

Returns:

the names used in named search clauses.

getResult

public TokenPattern.PatternResult getResult(java.lang.String source)

Tokenizes the given source and attempts a pattern match from the first token.

Parameters:

source -

Returns:

If source matches the pattern, a TokenPattern.PatternResult is returned. null otherwise.

getResult

public TokenPattern.PatternResult getResult(java.lang.String source,
                                            boolean startsWith)

Tokenizes the given source and attempts a pattern match from the first token, optionally scanning until a match is found if startsWith == false.

Parameters:

source -

startsWith -

Returns:

If source matches the pattern, a TokenPattern.PatternResult is returned. null otherwise.

getResult

public TokenPattern.PatternResult getResult(T startTk)

Attempts a pattern match from the given token.

Parameters:

startTk -

Returns:

If source from the given token matches the pattern, a TokenPattern.PatternResult is returned. null otherwise.

getResult

public TokenPattern.PatternResult getResult(T startTk,
                                            boolean startsWith)

Attempts a pattern match from the given token, optionally scanning until a match is found if startsWith == false.

Parameters:

startTk -

startsWith -

Returns:

If source from the given token matches the pattern, a TokenPattern.PatternResult is returned. null otherwise.

getResult

public TokenPattern.PatternResult getResult(T startTk,
                                            T endTk)

Attempts a pattern match from the given start token, upto the given end token.

Parameters:

startTk -

endTk -

Returns:

If source from the given token matches the pattern, a TokenPattern.PatternResult is returned. null otherwise.

getResult

public TokenPattern.PatternResult getResult(T startTk,
                                            T endTk,
                                            boolean startsWith)

Attempts a pattern match from the given token, upto the given end token, optionally scanning until a match is found if startsWith == false.

Parameters:

startTk -

endTk -

startsWith -

Returns:

If source from the given token matches the pattern, a TokenPattern.PatternResult is returned. null otherwise.