oracle.javatools.db.extension

Class DatabaseMatcher

java.lang.Object

oracle.javatools.db.extension.DatabaseMatcher

public class DatabaseMatcher
extends java.lang.Object

Immutable class used to match a database release by type and version(s).

Example 1: Match any Oracle database

 DatabaseMatcher dm =
   new DatabaseMatcher( OracleDatabase.ORACLE_DATABASE_TYPE );
 

Example 2: Match Oracle databases 10gR1 and above

 DatabaseMatcher dm =
   new DatabaseMatcher( OracleDatabase.ORACLE_DATABASE_TYPE,
                        OracleDatabase.ORACLE10g_TYPE,
                        DatabaseMatcher.Comparison.MINIMUM );
 

Example 3: Match only Oracle 11gR2

 DatabaseMatcher dm =
   new DatabaseMatcher( OracleDatabase.ORACLE_DATABASE_TYPE,
                        OracleDatabase.ORACLE11gR2_TYPE,
                        DatabaseMatcher.Comparison.EXACT );
 

Since:

11.1.1.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseMatcher.Comparison Used to indicate how the version should be matched.

Constructor Summary

Constructors

Constructor and Description
DatabaseMatcher(java.lang.String dbType) Matches all database of the given database type.
DatabaseMatcher(java.lang.String dbType, int version, DatabaseMatcher.Comparison comparison) Matches database of the given database type, by comparing the version number using the given comparison type.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Tests that the other object is a DatabaseMatcher with exactly the same criteria as this matcher.
java.lang.String	getDatabaseType() Gets the type of database this will match.
int	hashCode()
boolean	matches(java.lang.String databaseType, int databaseVersion) Tests whether this matcher matches the given database type and version.
protected boolean	matchesType(java.lang.String dbType)
protected boolean	matchesVersion(int version)
void	setTestSystemProperty(java.lang.String testSystemProperty) This is intended for internal/test use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseMatcher

public DatabaseMatcher(java.lang.String dbType)

Matches all database of the given database type.

DatabaseMatcher

public DatabaseMatcher(java.lang.String dbType,
               int version,
               DatabaseMatcher.Comparison comparison)

Matches database of the given database type, by comparing the version number using the given comparison type.

Method Detail

getDatabaseType

public java.lang.String getDatabaseType()

Gets the type of database this will match.

matchesType

protected boolean matchesType(java.lang.String dbType)

matchesVersion

protected boolean matchesVersion(int version)

matches

public boolean matches(java.lang.String databaseType,
              int databaseVersion)

Tests whether this matcher matches the given database type and version.

Parameters:

databaseType - the database type to match

databaseVersion - the database version to match

Returns:

true if the type and version match those defined for this matcher.

equals

public boolean equals(java.lang.Object obj)

Tests that the other object is a DatabaseMatcher with exactly the same criteria as this matcher.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setTestSystemProperty

public void setTestSystemProperty(java.lang.String testSystemProperty)

This is intended for internal/test use only. It tests a system property that will be evaulated during any match. All matches will fail unless the system property is "true".