org.wandora.application.tools.extractors

Class GenericDatabaseExtractor

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.GenericDatabaseExtractor

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, WandoraTool, WandoraToolLogger, TopicMapLogger

public class GenericDatabaseExtractor
extends AbstractWandoraTool

TODO: - Test that extending tables works properly, extend chains, no unnecessary associations from extending columns. - Test that all different kinds of tables work properly, different values of hasReferences and hasNonReferences (test this with extending another table and not). - Test that not including columns works properly.

Author:

olli

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericDatabaseExtractor.DatabaseSchema Data structure containing information about database schema.
static class	GenericDatabaseExtractor.DBColumn Datastructure containing information about a single column in a database schema.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.HashMap<java.lang.String,Topic>	topicCache

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
GenericDatabaseExtractor() Creates a new instance of GenericDatabaseExtractor

Method Summary

Modifier and Type	Method and Description
private boolean	configureSchema(Wandora admin, GenericDatabaseExtractor.DatabaseSchema schema)
static java.lang.String	cropBaseName(java.lang.String value, java.lang.String postfix)
void	execute(Wandora admin, Context context) Runs the tool.
static GenericDatabaseExtractor.DBColumn	findColumn(java.util.Collection<GenericDatabaseExtractor.DBColumn> columns, java.lang.String name)
static GenericDatabaseExtractor.DatabaseSchema	getDatabaseSchema(java.sql.DatabaseMetaData metadata, java.lang.String catalog, java.lang.String schema) Gets a database schema based on DatabaseMetaData.
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
Topic	getOrCreateCached(TopicMap tm, java.lang.String s)
static GenericDatabaseExtractor.DBColumn	getOrCreateColumn(java.util.HashMap<Tuples.T2<java.lang.String,java.lang.String>,GenericDatabaseExtractor.DBColumn> columns, java.lang.String table, java.lang.String column)
static Topic	getOrCreateTopic(TopicMap tm, java.lang.String s)
WandoraToolType	getType() Tool type is used to categorize tools.
static java.lang.String	makeIdentifier(java.lang.String[] row, GenericDatabaseExtractor.DBColumn[] columns, java.lang.String table)
void	makeTopicMap(TopicMap tm, java.sql.Connection con, GenericDatabaseExtractor.DatabaseSchema schema)
static void	printResultSet(java.sql.ResultSet rs)
static void	setDefaultBaseNameColumns(GenericDatabaseExtractor.DatabaseSchema schema) Sets the baseName attribute to true in one column of each table.

Methods inherited from class org.wandora.application.tools.AbstractWandoraTool

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, configure, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isConfigurable, isRunning, isRunning, lockLog, log, log, log, log, requiresRefresh, run, runInOwnThread, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap, writeOptions

Methods inherited from class java.lang.Object

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

Field Detail

topicCache

public java.util.HashMap<java.lang.String,Topic> topicCache

Constructor Detail

GenericDatabaseExtractor

public GenericDatabaseExtractor()

Creates a new instance of GenericDatabaseExtractor

Method Detail

getName

public java.lang.String getName()

Description copied from class: AbstractWandoraTool

Tools name represent the tool in UI unless the tool has been given explicitly another GUI name. All tools should override this method and return a valid string representing name of the tool.

Specified by:

getName in interface WandoraTool

Overrides:

getName in class AbstractWandoraTool

Returns:

String representing tool's name.

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractWandoraTool

AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu. By default description equals the tool name. All tools should override this method.

Specified by:

getDescription in interface WandoraTool

Overrides:

getDescription in class AbstractWandoraTool

Returns:

String representing tool's description.

getType

public WandoraToolType getType()

Description copied from class: AbstractWandoraTool

Tool type is used to categorize tools. Tool type has no real effect today, it is merely an informative property of a tool.

Specified by:

getType in interface WandoraTool

Overrides:

getType in class AbstractWandoraTool

Returns:

Tool's type object.

getIcon

public javax.swing.Icon getIcon()

Description copied from class: AbstractWandoraTool

All tools may have identifying graphic icon used within tool GUI elements. getIcon should return Icon object of the tool.

Specified by:

getIcon in interface WandoraTool

Overrides:

getIcon in class AbstractWandoraTool

Returns:

icon for the tool.

execute

public void execute(Wandora admin,
                    Context context)
             throws TopicMapException

Description copied from interface: WandoraTool

Runs the tool. This is the main entry to the tool. Here the context

Throws:

TopicMapException

configureSchema

private boolean configureSchema(Wandora admin,
                                GenericDatabaseExtractor.DatabaseSchema schema)

printResultSet

public static void printResultSet(java.sql.ResultSet rs)
                           throws java.sql.SQLException

Throws:

java.sql.SQLException

makeIdentifier

public static java.lang.String makeIdentifier(java.lang.String[] row,
                                              GenericDatabaseExtractor.DBColumn[] columns,
                                              java.lang.String table)
                                       throws java.sql.SQLException

Throws:

java.sql.SQLException

getOrCreateTopic

public static Topic getOrCreateTopic(TopicMap tm,
                                     java.lang.String s)
                              throws TopicMapException

Throws:

TopicMapException

getOrCreateCached

public Topic getOrCreateCached(TopicMap tm,
                               java.lang.String s)
                        throws TopicMapException

Throws:

TopicMapException

findColumn

public static GenericDatabaseExtractor.DBColumn findColumn(java.util.Collection<GenericDatabaseExtractor.DBColumn> columns,
                                                           java.lang.String name)

cropBaseName

public static java.lang.String cropBaseName(java.lang.String value,
                                            java.lang.String postfix)

makeTopicMap

public void makeTopicMap(TopicMap tm,
                         java.sql.Connection con,
                         GenericDatabaseExtractor.DatabaseSchema schema)
                  throws java.sql.SQLException,
                         TopicMapException

Throws:

java.sql.SQLException

TopicMapException

getOrCreateColumn

public static GenericDatabaseExtractor.DBColumn getOrCreateColumn(java.util.HashMap<Tuples.T2<java.lang.String,java.lang.String>,GenericDatabaseExtractor.DBColumn> columns,
                                                                  java.lang.String table,
                                                                  java.lang.String column)

setDefaultBaseNameColumns

public static void setDefaultBaseNameColumns(GenericDatabaseExtractor.DatabaseSchema schema)

Sets the baseName attribute to true in one column of each table. Tries to guess a column that would make the most sense as a base name, however currently the heuristic for this is very simple.

getDatabaseSchema

public static GenericDatabaseExtractor.DatabaseSchema getDatabaseSchema(java.sql.DatabaseMetaData metadata,
                                                                        java.lang.String catalog,
                                                                        java.lang.String schema)
                                                                 throws java.sql.SQLException

Gets a database schema based on DatabaseMetaData. Catalog and schema parameters are descibed in java.sql.DatabaseMetaData.getCrossReference. Practically, catalog is usually null and schema is the database user name. Thus you will usually do something like this:

 Connection con=DriverManager.getConnection(conString,user,pass);
 DatabaseMetaData metadata=con.getMetaData();
 DatabaseSchema schema=getDatabaseSchema(metadata,null,user);
 

Throws:

java.sql.SQLException