SPT RWT Application API

com.sptci.rwt
Class Analyser

java.lang.Object
  extended by com.sptci.rwt.Analyser
Direct Known Subclasses:
AbstractProcedureAnalyser, AbstractSequenceAnalyser, AbstractTriggerAnalyser, AbstractViewAnalyser, CatalogueAnalyser, ColumnAnalyser, DBMSAnalyser, KeyAnalyser, ProcedureAnalyser, SchemaAnalyser, SequenceAnalyser, TableTypeAnalyser, TriggerAnalyser

public abstract class Analyser
extends Object

An abstract base class analyser for the various database objects.

© Copyright 2007 Sans Pareil Technologies, Inc.

Version:
$Id: Analyser.java 4123 2008-05-25 21:49:01Z rakesh $
Author:
Rakesh Vidyadharan 2007-09-25

Nested Class Summary
protected  class Analyser.CatalogueSchema
          A value object used to represent the names of the catalogue and schema.
 
Field Summary
protected static Logger logger
          The logger to use to log errors/messages to.
protected  ConnectionManager manager
          The connection manager to use to fetch connections.
 
Constructor Summary
protected Analyser(ConnectionManager manager)
          Create a new instance of the class using the specified connection manager.
 
Method Summary
abstract  Collection<? extends MetaData> analyse(MetaData... parameters)
          Analyse the database connected to and return the appropriate metadata objects.
protected  Analyser.CatalogueSchema getNames(MetaData metaData)
          Return a value object that represents the names of the catalogue and/or schema specified.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected static final Logger logger
The logger to use to log errors/messages to.


manager

protected final ConnectionManager manager
The connection manager to use to fetch connections.

Constructor Detail

Analyser

protected Analyser(ConnectionManager manager)
Create a new instance of the class using the specified connection manager.

Parameters:
manager - The connection manager to use.
Method Detail

analyse

public abstract Collection<? extends MetaData> analyse(MetaData... parameters)
                                                throws SQLException
Analyse the database connected to and return the appropriate metadata objects. Returns a collection of metadata objects that represent all the objects of this type available to the user.

Parameters:
parameters - Optional parameters that are required to analyse objects of this type.
Returns:
The collection of metadata objects representing all objects of this type.
Throws:
SQLException - If errors are encountered while analysisng the

getNames

protected Analyser.CatalogueSchema getNames(MetaData metaData)
Return a value object that represents the names of the catalogue and/or schema specified.

Parameters:
metaData - The meta data object out of which the names are to be retrieved.
Returns:
The value object that contains the names.
Since:
Version 1.1

SPT RWT Application API