com.screenscraper.datamanager.sql

Class SqlSchemaBuilder

java.lang.Object

com.screenscraper.datamanager.sql.SqlSchemaBuilder

public class SqlSchemaBuilder
extends java.lang.Object

a class that parses the schemas from the database meta data. This is called from the SqlDataManager by the buildSchemas method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SqlSchemaBuilder.ForeignKeyBuilder
(package private) static class	SqlSchemaBuilder.ParsedSchema

Constructor Summary

Constructors

Constructor and Description
SqlSchemaBuilder(SqlDataManager dm, java.lang.String schemaName) Generates the schemas from the database meta data
SqlSchemaBuilder(SqlDataManager dm, java.lang.String schemaName, boolean rebuild) Generates the schemas from the database meta data

Method Summary

Modifier and Type	Method and Description
static void	cleanupStoredSchemas() Cleans up the current schema entries, removing expired schemas.
static void	clearParsedSchemas() Clears all the currently known schemas for all databases
static boolean	hasParsedSchema(java.lang.String url, java.lang.String parsedSchemaName) Returns whether or not there is a currently known parsed schema for the specified url
void	parseForeignKeys(RelationalSchema relationalSchema, DatabaseSchema schemas, java.sql.DatabaseMetaData meta) Parses the foreign keys for the given schema from the database.
DatabaseSchema	parseSchemasFromDb() returns constructs and returns the Schemas for the database
DatabaseSchema	parseSchemasFromDb(java.util.List<java.lang.String> tables) returns constructs and returns the Schemas for the database for the specified tables.

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlSchemaBuilder

public SqlSchemaBuilder(@NotNull
                        SqlDataManager dm,
                        @Nullable
                        java.lang.String schemaName)

Generates the schemas from the database meta data

Parameters:

dm - The data manager

schemaName - The name of the schema to parse for (or to parse all)

SqlSchemaBuilder

public SqlSchemaBuilder(@NotNull
                        SqlDataManager dm,
                        @Nullable
                        java.lang.String schemaName,
                        boolean rebuild)

Generates the schemas from the database meta data

Parameters:

dm - The data manager

schemaName - The name of the schema to parse for (or to parse all)

rebuild - True if the schema should be rebuilt if it was already known

Method Detail

cleanupStoredSchemas

public static void cleanupStoredSchemas()

Cleans up the current schema entries, removing expired schemas. Internally checks to ensure we don't cleanup too often

hasParsedSchema

public static boolean hasParsedSchema(@NotNull
                                      java.lang.String url,
                                      @Nullable
                                      java.lang.String parsedSchemaName)

Returns whether or not there is a currently known parsed schema for the specified url

Parameters:

url - The url for connecting to the database

parsedSchemaName - The parsed schema name if one was specified (for PostegreSQL mainly)

Returns:

True if a schema is currently stored in the known schemas, false otherwise

clearParsedSchemas

public static void clearParsedSchemas()

Clears all the currently known schemas for all databases

parseSchemasFromDb

@Nullable
public DatabaseSchema parseSchemasFromDb()

returns constructs and returns the Schemas for the database

Returns:

Schemas parsed from database

parseSchemasFromDb

@Nullable
public DatabaseSchema parseSchemasFromDb(@NotNull
                                                    java.util.List<java.lang.String> tables)

returns constructs and returns the Schemas for the database for the specified tables. If there are a lot of not relevant tables in the database using this method speeds up parsing significantly

Parameters:

tables - The tables for which to parse a schema

Returns:

DatabaseSchema

parseForeignKeys

public void parseForeignKeys(@NotNull
                             RelationalSchema relationalSchema,
                             @NotNull
                             DatabaseSchema schemas,
                             @NotNull
                             java.sql.DatabaseMetaData meta)
                      throws java.sql.SQLException

Parses the foreign keys for the given schema from the database. This looks up all the foreign Keys pointing to a tables pk.

Parameters:

relationalSchema - The schema for which to parse foreign keys

schemas - The schemas in the database

meta - The database meta data

Throws:

java.sql.SQLException - On error reading the data