com.buschmais.jqassistant.plugin.rdbms.impl.scanner

Class AbstractSchemaScannerPlugin<I,D extends ConnectionDescriptor>

java.lang.Object

com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<I,D>

com.buschmais.jqassistant.plugin.rdbms.impl.scanner.AbstractSchemaScannerPlugin<I,D>

All Implemented Interfaces:

com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<I,D>

Direct Known Subclasses:

ConnectionPropertyFileScannerPlugin, ConnectionUriScannerPlugin

public abstract class AbstractSchemaScannerPlugin<I,D extends ConnectionDescriptor>
extends com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<I,D>

Abstract base class for database schema scanners.

Nested Class Summary

Nested classes/interfaces inherited from interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin

com.buschmais.jqassistant.core.scanner.api.ScannerPlugin.Requires

Constructor Summary

Constructors

Constructor and Description
AbstractSchemaScannerPlugin()

Method Summary

Modifier and Type	Method and Description
protected schemacrawler.schema.Catalog	getCatalog(String url, String user, String password, String infoLevelName, String bundledDriverName, Properties properties) Retrieves the catalog metadata using schema crawler.
Class<D>	getDescriptorType()
Class<? extends I>	getType()
protected List<SchemaDescriptor>	scanConnection(String url, String user, String password, String infoLevelName, String bundledDriverName, Properties properties, com.buschmais.jqassistant.core.store.api.Store store) Scans the connection identified by the given parameters.

Methods inherited from class com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin

configure, configure, equals, getBooleanProperty, getDirectoryPath, getProperties, getProperty, getScannerContext, getStringProperty, getTypeParameter, hashCode, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin

accepts, scan

Constructor Detail

AbstractSchemaScannerPlugin

public AbstractSchemaScannerPlugin()

Method Detail

getType

public Class<? extends I> getType()

Specified by:

getType in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<I,D extends ConnectionDescriptor>

Overrides:

getType in class com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<I,D extends ConnectionDescriptor>

getDescriptorType

public Class<D> getDescriptorType()

Specified by:

getDescriptorType in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<I,D extends ConnectionDescriptor>

Overrides:

getDescriptorType in class com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<I,D extends ConnectionDescriptor>

scanConnection

protected List<SchemaDescriptor> scanConnection(String url,
                                                String user,
                                                String password,
                                                String infoLevelName,
                                                String bundledDriverName,
                                                Properties properties,
                                                com.buschmais.jqassistant.core.store.api.Store store)
                                         throws IOException

Scans the connection identified by the given parameters.

Parameters:

url - The url.

user - The user.

password - The password.

properties - The properties to pass to schema crawler.

infoLevelName - The name of the info level to use.

bundledDriverName - The name of the bundled driver as provided by schema crawler.

store - The store.

Returns:

The list of created schema descriptors.

Throws:

IOException - If retrieval fails.

getCatalog

protected schemacrawler.schema.Catalog getCatalog(String url,
                                                  String user,
                                                  String password,
                                                  String infoLevelName,
                                                  String bundledDriverName,
                                                  Properties properties)
                                           throws IOException

Retrieves the catalog metadata using schema crawler.

Parameters:

url - The url.

user - The user.

password - The password.

properties - The properties to pass to schema crawler.

infoLevelName - The name of the info level to use.

bundledDriverName - The name of the bundled driver as provided by schema crawler.

Returns:

The catalog.

Throws:

IOException - If retrieval fails.