oracle.javatools.db.plsql

Class PlSqlSearch

java.lang.Object

oracle.javatools.db.plsql.PlSqlSearch

public class PlSqlSearch
extends java.lang.Object

PlSqlSearch provides a mechanism for searching PlSqlTokens. All features are provided by the TokenPattern class which supercedes PlSqlSearch. PlSqlSearch itself is not thread safe as subsequent calls to matches(java.lang.String) or isWithin(java.lang.String) will reset the internals of the search, affecting any other thread that was calling getNamedMatch(String) etc.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PlSqlToken	getEndToken()
java.lang.String	getNamedMatch(java.lang.String name)
java.lang.String	getNamedMatch(java.lang.String name, boolean format) Returns the results of a named search clause.
PlSqlToken	getNamedMatchEndToken(java.lang.String name)
PlSqlToken	getNamedMatchStartToken(java.lang.String name)
java.lang.String[]	getNames()
PlSqlToken	getStartToken()
int	getTokenCount()
boolean	isWithin(PlSqlToken startToken)
boolean	isWithin(PlSqlToken startToken, PlSqlToken endToken)
boolean	isWithin(java.lang.String source)
boolean	matches(PlSqlToken startToken)
boolean	matches(PlSqlToken startToken, PlSqlToken endToken)
boolean	matches(java.lang.String source)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlSqlSearch

public PlSqlSearch(java.lang.String expression)

Constructs a PlSqlSearch with the given expression.

Parameters:

expression -

Throws:

java.lang.IllegalArgumentException

Method Detail

matches

public final boolean matches(java.lang.String source)

Returns:

true if the PlSqlSearch matches the source, false otherwise.

matches

public final boolean matches(PlSqlToken startToken)

Returns:

true if the PlSqlSearch matches the list of PlSqlTokens starting at startToken, false otherwise.

matches

public final boolean matches(PlSqlToken startToken,
                             PlSqlToken endToken)

Returns:

true if the PlSqlSearch matches the list of PlSqlTokens starting at startToken and not extending past endToken, false otherwise.

isWithin

public final boolean isWithin(java.lang.String source)

Returns:

true if the PlSqlSearch is found within the given source, false otherwise.

isWithin

public final boolean isWithin(PlSqlToken startToken)

Returns:

true if the PlSqlSearch is found within the list of PlSqlTokens starting at startToken, false otherwise.

isWithin

public final boolean isWithin(PlSqlToken startToken,
                              PlSqlToken endToken)

Returns:

true if the PlSqlSearch is found within the list of PlSqlTokens starting at startToken and not extending past endToken, false otherwise.

getNamedMatch

public final java.lang.String getNamedMatch(java.lang.String name)

Returns:

the formatted result of a named Seach Clause within the PlSqlSearch if that clause matched. See getNamedMatch(String name, boolean format)

getNamedMatch

public final java.lang.String getNamedMatch(java.lang.String name,
                                            boolean format)

Returns the results of a named search clause.

Parameters:

name - The search clause name.

format - how the match should be returned

• if format == false, the results are the exact string from the original source from the start of the match to end. This will preserve the case of the original source, include whitespace and comments.
  
• if format == true, the results will have comments removed, alphanumerics (other than string literals) will be forced to uppercase, and white space will just be around alphanumerics and following right parenthesis.

Returns:

the result of a named Seach Clause within the PlSqlSearch if that clause matched. If named clause did not produce a match, or the name cannot be found, null is returned.

getNamedMatchStartToken

public final PlSqlToken getNamedMatchStartToken(java.lang.String name)

getNamedMatchEndToken

public final PlSqlToken getNamedMatchEndToken(java.lang.String name)

getStartToken

public PlSqlToken getStartToken()

Returns:

the first token of a successful match, or null if match failed

getEndToken

public PlSqlToken getEndToken()

Returns:

the last token of a successful match, or null if match failed

getNames

public java.lang.String[] getNames()

Returns:

the names used in named search clauses.

getTokenCount

public int getTokenCount()