net.sf.jailer.datamodel

Class DataModel

java.lang.Object

net.sf.jailer.datamodel.DataModel

public class DataModel
extends java.lang.Object

Relational data model.

Author:

Ralf Wisser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataModel.ColumnOrderPriority Order priority of a column.
static class	DataModel.NoPrimaryKeyException Thrown if a table has no primary key.
static class	DataModel.XmlSettings Holds XML settings for exportation into XML files.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,DataModel.ColumnOrderPriority>	columnOrderPrio Maps normalized column name to order priority.
java.util.Set<java.lang.String>	decisionPending Set of names of associations for which no decision has been made.
static java.lang.String	DEFAULT_NAME Default model name.
static java.lang.String	MODELNAME_CSV_FILE
java.util.Map<java.lang.String,Association>	namedAssociations Maps association-names to associations;
static java.lang.String	TABLE_CSV_FILE
long	version Internal version number.

Constructor Summary

Constructors

Constructor and Description
DataModel(ExecutionContext executionContext) Reads in table.csv and association.csv and builds the relational data model.
DataModel(KnownIdentifierMap knownIdentifiers, ExecutionContext executionContext) Reads in table.csv and association.csv and builds the relational data model.
DataModel(java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping, ExecutionContext executionContext, boolean failOnMissingTables) Reads in table.csv and association.csv and builds the relational data model.
DataModel(PrimaryKeyFactory primaryKeyFactory, java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping, ExecutionContext executionContext) Reads in table.csv and association.csv and builds the relational data model.
DataModel(java.lang.String additionalTablesFile, java.lang.String additionalAssociationsFile, ExecutionContext executionContext) Reads in table.csv and association.csv and builds the relational data model.
DataModel(java.lang.String additionalTablesFile, java.lang.String additionalAssociationsFile, java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping, CsvFile.LineFilter assocFilter, ExecutionContext executionContext) Reads in table.csv and association.csv and builds the relational data model.
DataModel(java.lang.String additionalTablesFile, java.lang.String additionalAssociationsFile, java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping, CsvFile.LineFilter assocFilter, PrimaryKeyFactory primaryKeyFactory, ExecutionContext executionContext, boolean failOnMissingTables) Reads in table.csv and association.csv and builds the relational data model.
DataModel(java.lang.String additionalTablesFile, java.lang.String additionalAssociationsFile, java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping, CsvFile.LineFilter assocFilter, PrimaryKeyFactory primaryKeyFactory, ExecutionContext executionContext, boolean failOnMissingTables, KnownIdentifierMap knownIdentifiers) Reads in table.csv and association.csv and builds the relational data model.
DataModel(java.lang.String additionalTablesFile, java.lang.String additionalAssociationsFile, PrimaryKeyFactory primaryKeyFactory, ExecutionContext executionContext) Reads in table.csv and association.csv and builds the relational data model.

Method Summary

Modifier and Type	Method and Description
static void	addRestrictedDependencyWithNulledFK(java.util.Set<Table> tables)
void	assignAssociationIDs() Assigns a unique ID to each association.
java.util.Set<Table>	checkForPrimaryKey(java.util.Set<Table> subjects, boolean hasRowID) Checks whether all tables in the closure of a given subject have primary keys.
void	deriveFilters() Removes all derived filters and renews them.
static java.lang.String	getAssociationsFile(ExecutionContext executionContext) Gets name of file containing the association definitions.
static java.lang.String	getColumnsFile(ExecutionContext executionContext) Gets name of file containing the column definitions.
java.lang.String	getComment(Table table, Column column)
static java.lang.String	getCommentsFile(ExecutionContext executionContext) Gets name of file containing the comments.
static java.lang.String	getDatamodelFolder(ExecutionContext executionContext) Gets name of data model folder.
java.lang.String	getDisplayName(Table table) Gets display name of a table
static java.lang.String	getDisplayNamesFile(ExecutionContext executionContext) Gets name of file containing the display names.
static java.lang.String	getExcludeFromDeletionFile(ExecutionContext executionContext) List of tables to be excluded from deletion.
java.lang.String	getExportModus() Gets export modus, SQL or XML.
java.util.List<FilterTemplate>	getFilterTemplates() Gets the FilterTemplates ordered by priority.
java.util.Set<Table>	getIndependentTables(java.util.Set<Table> tableSet) Gets all independent tables (i.e. tables which don't depend on other tables in the set) of a given table-set.
java.util.Set<Table>	getIndependentTables(java.util.Set<Table> tableSet, java.util.Set<Association> associations) Gets all independent tables (i.e. tables which don't depend on other tables in the set) of a given table-set.
java.lang.Long	getLastModified() Gets time of last modification.
java.lang.String	getLastModifiedAsString() Gets getLastModified() as String.
static java.lang.String	getModelNameFile(ExecutionContext executionContext) Gets name of file containing the model name
java.lang.String	getName() Gets name of the model.
java.util.SortedSet<java.lang.String>	getParameters(java.lang.String subjectCondition, java.util.List<ExtractionModel.AdditionalSubject> additionalSubjects) Gets all parameters which occur in subject condition, association restrictions or XML templates.
RestrictionModel	getRestrictionModel() Gets the restriction model.
java.util.List<Table>	getSortedTables() Gets list of tables sorted by name.
Table	getTable(java.lang.String name) Gets a table by name.
Table	getTableByDisplayName(java.lang.String displayName) Gets a table by display name.
Table	getTableByOrdinal(int ordinal) Gets table by Table.getOrdinal().
java.util.Collection<Table>	getTables() Gets all tables.
static java.lang.String	getTablesFile(ExecutionContext executionContext) Gets name of file containing the table definitions.
long	getVersion() Gets internal version number.
static java.lang.String	getVersionFile(ExecutionContext executionContext) Name of file containing the version number.
DataModel.XmlSettings	getXmlSettings() Gets XML settings for exportation into XML files.
java.util.Set<Table>	normalize(java.util.Set<Table> tables) Normalizes a set of tables.
void	save(java.lang.String file, Table stable, SubjectLimitDefinition subjectLimitDefinition, java.lang.String subjectCondition, ScriptFormat scriptFormat, java.util.List<RestrictionDefinition> restrictionDefinitions, java.util.Map<java.lang.String,java.util.Map<java.lang.String,double[]>> positions, java.util.List<ExtractionModel.AdditionalSubject> additionalSubjects, java.lang.String currentModelSubfolder) Saves the data model.
void	saveColumnOrderPrio() Saves the order priority of the columns.
void	saveRestrictions(java.io.File file, java.util.List<RestrictionDefinition> restrictionDefinitions) Saves restrictions only.
void	setExportModus(java.lang.String modus) Sets export modus, SQL or XML.
void	setRestrictionModel(RestrictionModel restrictionModel) Sets the restriction model.
void	setXmlSettings(DataModel.XmlSettings xmlSettings) Sets XML settings for exportation into XML files.
java.lang.String	toString() Stringifies the data model.
void	transpose() Transposes the data-model.

Methods inherited from class java.lang.Object

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

Field Detail

TABLE_CSV_FILE

public static final java.lang.String TABLE_CSV_FILE

See Also:

Constant Field Values

MODELNAME_CSV_FILE

public static final java.lang.String MODELNAME_CSV_FILE

See Also:

Constant Field Values

namedAssociations

public java.util.Map<java.lang.String,Association> namedAssociations

Maps association-names to associations;

decisionPending

public java.util.Set<java.lang.String> decisionPending

Set of names of associations for which no decision has been made.

columnOrderPrio

public final java.util.Map<java.lang.String,DataModel.ColumnOrderPriority> columnOrderPrio

Maps normalized column name to order priority.

version

public long version

Internal version number. Incremented on each modification.

DEFAULT_NAME

public static final java.lang.String DEFAULT_NAME

Default model name.

See Also:

Constant Field Values

Constructor Detail

DataModel

public DataModel(PrimaryKeyFactory primaryKeyFactory,
                 java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping,
                 ExecutionContext executionContext)
          throws java.io.IOException

Reads in table.csv and association.csv and builds the relational data model.

Throws:

java.io.IOException

DataModel

public DataModel(ExecutionContext executionContext)
          throws java.io.IOException

Reads in table.csv and association.csv and builds the relational data model.

Throws:

java.io.IOException

DataModel

public DataModel(KnownIdentifierMap knownIdentifiers,
                 ExecutionContext executionContext)
          throws java.io.IOException

Reads in table.csv and association.csv and builds the relational data model.

Parameters:

knownIdentifiers -

Throws:

java.io.IOException

DataModel

public DataModel(java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping,
                 ExecutionContext executionContext,
                 boolean failOnMissingTables)
          throws java.io.IOException

Reads in table.csv and association.csv and builds the relational data model.

Throws:

java.io.IOException

DataModel

public DataModel(java.lang.String additionalTablesFile,
                 java.lang.String additionalAssociationsFile,
                 PrimaryKeyFactory primaryKeyFactory,
                 ExecutionContext executionContext)
          throws java.io.IOException

Reads in table.csv and association.csv and builds the relational data model.

Parameters:

additionalTablesFile - table file to read too

additionalAssociationsFile - association file to read too

Throws:

java.io.IOException

DataModel

public DataModel(java.lang.String additionalTablesFile,
                 java.lang.String additionalAssociationsFile,
                 ExecutionContext executionContext)
          throws java.io.IOException

Reads in table.csv and association.csv and builds the relational data model.

Parameters:

additionalTablesFile - table file to read too

additionalAssociationsFile - association file to read too

Throws:

java.io.IOException

DataModel

public DataModel(java.lang.String additionalTablesFile,
                 java.lang.String additionalAssociationsFile,
                 java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping,
                 CsvFile.LineFilter assocFilter,
                 ExecutionContext executionContext)
          throws java.io.IOException

Reads in table.csv and association.csv and builds the relational data model.

Parameters:

additionalTablesFile - table file to read too

additionalAssociationsFile - association file to read too

Throws:

java.io.IOException

DataModel

public DataModel(java.lang.String additionalTablesFile,
                 java.lang.String additionalAssociationsFile,
                 java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping,
                 CsvFile.LineFilter assocFilter,
                 PrimaryKeyFactory primaryKeyFactory,
                 ExecutionContext executionContext,
                 boolean failOnMissingTables)
          throws java.io.IOException

Reads in table.csv and association.csv and builds the relational data model.

Parameters:

additionalTablesFile - table file to read too

additionalAssociationsFile - association file to read too

Throws:

java.io.IOException

DataModel

public DataModel(java.lang.String additionalTablesFile,
                 java.lang.String additionalAssociationsFile,
                 java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping,
                 CsvFile.LineFilter assocFilter,
                 PrimaryKeyFactory primaryKeyFactory,
                 ExecutionContext executionContext,
                 boolean failOnMissingTables,
                 KnownIdentifierMap knownIdentifiers)
          throws java.io.IOException

Reads in table.csv and association.csv and builds the relational data model.

Parameters:

additionalTablesFile - table file to read too

additionalAssociationsFile - association file to read too

Throws:

java.io.IOException

Method Detail

getDatamodelFolder

public static java.lang.String getDatamodelFolder(ExecutionContext executionContext)

Gets name of data model folder.

getTablesFile

public static java.lang.String getTablesFile(ExecutionContext executionContext)

Gets name of file containing the table definitions.

getModelNameFile

public static java.lang.String getModelNameFile(ExecutionContext executionContext)

Gets name of file containing the model name

getDisplayNamesFile

public static java.lang.String getDisplayNamesFile(ExecutionContext executionContext)

Gets name of file containing the display names.

getColumnsFile

public static java.lang.String getColumnsFile(ExecutionContext executionContext)

Gets name of file containing the column definitions.

getAssociationsFile

public static java.lang.String getAssociationsFile(ExecutionContext executionContext)

Gets name of file containing the association definitions.

getCommentsFile

public static java.lang.String getCommentsFile(ExecutionContext executionContext)

Gets name of file containing the comments.

getExcludeFromDeletionFile

public static java.lang.String getExcludeFromDeletionFile(ExecutionContext executionContext)

List of tables to be excluded from deletion.

getVersionFile

public static java.lang.String getVersionFile(ExecutionContext executionContext)

Name of file containing the version number.

getTable

public Table getTable(java.lang.String name)

Gets a table by name.

Parameters:

name - the name of the table

Returns:

the table or null iff no table with the name exists

getTableByDisplayName

public Table getTableByDisplayName(java.lang.String displayName)

Gets a table by display name.

Parameters:

displayName - the display name of the table

Returns:

the table or null iff no table with the display name exists

getName

public java.lang.String getName()

Gets name of the model.

Returns:

name of the model

getLastModified

public java.lang.Long getLastModified()

Gets time of last modification.

Returns:

time of last modification

getDisplayName

public java.lang.String getDisplayName(Table table)

Gets display name of a table

Parameters:

table - the table

Returns:

the display name of the table

getTables

public java.util.Collection<Table> getTables()

Gets all tables.

Returns:

a collection of all tables

getRestrictionModel

public RestrictionModel getRestrictionModel()

Gets the restriction model.

Returns:

the restriction model

setRestrictionModel

public void setRestrictionModel(RestrictionModel restrictionModel)

Sets the restriction model.

Parameters:

restrictionModel - the restriction model

getIndependentTables

public java.util.Set<Table> getIndependentTables(java.util.Set<Table> tableSet)

Gets all independent tables (i.e. tables which don't depend on other tables in the set) of a given table-set.

Parameters:

tableSet - the table-set

Returns:

the sub-set of independent tables of the table-set

getIndependentTables

public java.util.Set<Table> getIndependentTables(java.util.Set<Table> tableSet,
                                                 java.util.Set<Association> associations)

Gets all independent tables (i.e. tables which don't depend on other tables in the set) of a given table-set.

Parameters:

tableSet - the table-set

associations - the associations to consider, null for all associations

Returns:

the sub-set of independent tables of the table-set

transpose

public void transpose()

Transposes the data-model.

toString

public java.lang.String toString()

Stringifies the data model.

Overrides:

toString in class java.lang.Object

getSortedTables

public java.util.List<Table> getSortedTables()

Gets list of tables sorted by name.

Returns:

list of tables sorted by name

normalize

public java.util.Set<Table> normalize(java.util.Set<Table> tables)

Normalizes a set of tables.

Parameters:

tables - set of tables

Returns:

set of all tables from this model for which a table with same name exists in tables

assignAssociationIDs

public void assignAssociationIDs()

Assigns a unique ID to each association.

getExportModus

public java.lang.String getExportModus()

Gets export modus, SQL or XML. (GUI support).

setExportModus

public void setExportModus(java.lang.String modus)

Sets export modus, SQL or XML. (GUI support).

getXmlSettings

public DataModel.XmlSettings getXmlSettings()

Gets XML settings for exportation into XML files.

setXmlSettings

public void setXmlSettings(DataModel.XmlSettings xmlSettings)

Sets XML settings for exportation into XML files.

getVersion

public long getVersion()

Gets internal version number. Incremented on each modification.

Returns:

internal version number. Incremented on each modification.

checkForPrimaryKey

public java.util.Set<Table> checkForPrimaryKey(java.util.Set<Table> subjects,
                                               boolean hasRowID)
                                        throws DataModel.NoPrimaryKeyException

Checks whether all tables in the closure of a given subject have primary keys.

Parameters:

subjects - the subjects

hasRowID -

Throws:

DataModel.NoPrimaryKeyException - if a table has no primary key

getParameters

public java.util.SortedSet<java.lang.String> getParameters(java.lang.String subjectCondition,
                                                           java.util.List<ExtractionModel.AdditionalSubject> additionalSubjects)

Gets all parameters which occur in subject condition, association restrictions or XML templates.

Parameters:

subjectCondition - the subject condition

Returns:

all parameters which occur in subject condition, association restrictions or XML templates

getLastModifiedAsString

public java.lang.String getLastModifiedAsString()

Gets getLastModified() as String.

Returns:

getLastModified() as String

save

public void save(java.lang.String file,
                 Table stable,
                 SubjectLimitDefinition subjectLimitDefinition,
                 java.lang.String subjectCondition,
                 ScriptFormat scriptFormat,
                 java.util.List<RestrictionDefinition> restrictionDefinitions,
                 java.util.Map<java.lang.String,java.util.Map<java.lang.String,double[]>> positions,
                 java.util.List<ExtractionModel.AdditionalSubject> additionalSubjects,
                 java.lang.String currentModelSubfolder)
          throws java.io.FileNotFoundException

Saves the data model.

Parameters:

file - the file name

stable -

stable - the subject table

subjectLimitDefinition - limit of subject

subjectCondition -

scriptFormat -

positions - table positions or null

additionalSubjects -

Throws:

java.io.FileNotFoundException

saveRestrictions

public void saveRestrictions(java.io.File file,
                             java.util.List<RestrictionDefinition> restrictionDefinitions)
                      throws java.io.FileNotFoundException

Saves restrictions only.

Parameters:

file - to save restrictions into

Throws:

java.io.FileNotFoundException

saveColumnOrderPrio

public void saveColumnOrderPrio()
                         throws java.io.FileNotFoundException

Saves the order priority of the columns.

Throws:

java.io.FileNotFoundException

getTableByOrdinal

public Table getTableByOrdinal(int ordinal)

Gets table by Table.getOrdinal().

Parameters:

ordinal - the ordinal

Returns:

the table

getFilterTemplates

public java.util.List<FilterTemplate> getFilterTemplates()

Gets the FilterTemplates ordered by priority.

Returns:

template list

deriveFilters

public void deriveFilters()

Removes all derived filters and renews them.

addRestrictedDependencyWithNulledFK

public static void addRestrictedDependencyWithNulledFK(java.util.Set<Table> tables)

getComment

public java.lang.String getComment(Table table,
                                   Column column)