DataModel (Jailer Subsetter API)

java.lang.Object
- net.sf.jailer.datamodel.DataModel

```
public class DataModel
extends Object
```
Relational data model.

Author:

Ralf Wisser

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`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
`static String`	`DEFAULT_NAME` Default model name.
`static String`	`MODELNAME_CSV_FILE`
`Map<String,Association>`	`namedAssociations` Maps association-names to associations;
`static boolean`	`printClosures` Printing-mode.
`static 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(Map<String,String> sourceSchemaMapping, ExecutionContext executionContext, boolean failOnMissingTables)` Reads in `table.csv` and `association.csv` and builds the relational data model.
`DataModel(PrimaryKeyFactory primaryKeyFactory, Map<String,String> sourceSchemaMapping, ExecutionContext executionContext)` Reads in `table.csv` and `association.csv` and builds the relational data model.
`DataModel(String additionalTablesFile, String additionalAssociationsFile, ExecutionContext executionContext)` Reads in `table.csv` and `association.csv` and builds the relational data model.
`DataModel(String additionalTablesFile, String additionalAssociationsFile, Map<String,String> sourceSchemaMapping, CsvFile.LineFilter assocFilter, ExecutionContext executionContext)` Reads in `table.csv` and `association.csv` and builds the relational data model.
`DataModel(String additionalTablesFile, String additionalAssociationsFile, Map<String,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(String additionalTablesFile, String additionalAssociationsFile, PrimaryKeyFactory primaryKeyFactory, ExecutionContext executionContext)` Reads in `table.csv` and `association.csv` and builds the relational data model.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`assignAssociationIDs()` Assigns a unique ID to each association.
`void`	`checkForPrimaryKey(Set<Table> subjects, boolean forDeletion)` Checks whether all tables in the closure of a given subject have primary keys.
`void`	`deriveFilters()` Removes all derived filters and renews them.
`static String`	`getAssociationsFile(ExecutionContext executionContext)` Gets name of file containing the association definitions.
`static String`	`getColumnsFile(ExecutionContext executionContext)` Gets name of file containing the column definitions.
`static String`	`getDatamodelFolder(ExecutionContext executionContext)` Gets name of data model folder.
`String`	`getDisplayName(Table table)` Gets display name of a table
`static String`	`getDisplayNamesFile(ExecutionContext executionContext)` Gets name of file containing the display names.
`static String`	`getExcludeFromDeletionFile(ExecutionContext executionContext)` List of tables to be excluded from deletion.
`String`	`getExportModus()` Gets export modus, SQL or XML.
`List<FilterTemplate>`	`getFilterTemplates()` Gets the `FilterTemplate`s ordered by priority.
`Set<Table>`	`getIndependentTables(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.
`Set<Table>`	`getIndependentTables(Set<Table> tableSet, 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.
`Long`	`getLastModified()` Gets time of last modification.
`String`	`getLastModifiedAsString()` Gets `getLastModified()` as String.
`static String`	`getModelNameFile(ExecutionContext executionContext)` Gets name of file containing the model name
`String`	`getName()` Gets name of the model.
`SortedSet<String>`	`getParameters(String subjectCondition, List<ExtractionModel.AdditionalSubject> additionalSubjects)` Gets all parameters which occur in subject condition, association restrictions or XML templates.
`RestrictionModel`	`getRestrictionModel()` Gets the restriction model.
`List<Table>`	`getSortedTables()` Gets list of tables sorted by name.
`Table`	`getTable(String name)` Gets a table by name.
`Table`	`getTableByDisplayName(String displayName)` Gets a table by display name.
`Table`	`getTableByOrdinal(int ordinal)` Gets table by `Table.getOrdinal()`.
`Collection<Table>`	`getTables()` Gets all tables.
`static String`	`getTablesFile(ExecutionContext executionContext)` Gets name of file containing the table definitions.
`long`	`getVersion()` Gets internal version number.
`static String`	`getVersionFile(ExecutionContext executionContext)` Name of file containing the version number.
`DataModel.XmlSettings`	`getXmlSettings()` Gets XML settings for exportation into XML files.
`Set<Table>`	`normalize(Set<Table> tables)` Normalizes a set of tables.
`void`	`save(String file, Table stable, String subjectCondition, ScriptFormat scriptFormat, List<RestrictionDefinition> restrictionDefinitions, Map<String,Map<String,double[]>> positions, List<ExtractionModel.AdditionalSubject> additionalSubjects, String currentModelSubfolder)` Saves the data model.
`void`	`saveRestrictions(File file, List<RestrictionDefinition> restrictionDefinitions)` Saves restrictions only.
`void`	`setExportModus(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.
`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 String TABLE_CSV_FILE
```
    See Also:
    Constant Field Values
  - MODELNAME_CSV_FILE
```
public static final String MODELNAME_CSV_FILE
```
    See Also:
    Constant Field Values
  - namedAssociations
```
public Map<String,Association> namedAssociations
```
    Maps association-names to associations;
  - version
```
public long version
```
    Internal version number. Incremented on each modification.
  - DEFAULT_NAME
```
public static final String DEFAULT_NAME
```
    Default model name.
    
    See Also:
    Constant Field Values
  - printClosures
```
public static boolean printClosures
```
    Printing-mode.
- Constructor Detail
  - DataModel
```
public DataModel(PrimaryKeyFactory primaryKeyFactory,
         Map<String,String> sourceSchemaMapping,
         ExecutionContext executionContext)
          throws IOException
```
    Reads in table.csv and association.csv and builds the relational data model.
    
    Throws:
    
    IOException
  - DataModel
```
public DataModel(ExecutionContext executionContext)
          throws IOException
```
    Reads in table.csv and association.csv and builds the relational data model.
    
    Throws:
    
    IOException
  - DataModel
```
public DataModel(Map<String,String> sourceSchemaMapping,
         ExecutionContext executionContext,
         boolean failOnMissingTables)
          throws IOException
```
    Reads in table.csv and association.csv and builds the relational data model.
    
    Throws:
    
    IOException
  - DataModel
```
public DataModel(String additionalTablesFile,
         String additionalAssociationsFile,
         PrimaryKeyFactory primaryKeyFactory,
         ExecutionContext executionContext)
          throws 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:
    
    IOException
  - DataModel
```
public DataModel(String additionalTablesFile,
         String additionalAssociationsFile,
         ExecutionContext executionContext)
          throws 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:
    
    IOException
  - DataModel
```
public DataModel(String additionalTablesFile,
         String additionalAssociationsFile,
         Map<String,String> sourceSchemaMapping,
         CsvFile.LineFilter assocFilter,
         ExecutionContext executionContext)
          throws 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:
    
    IOException
  - DataModel
```
public DataModel(String additionalTablesFile,
         String additionalAssociationsFile,
         Map<String,String> sourceSchemaMapping,
         CsvFile.LineFilter assocFilter,
         PrimaryKeyFactory primaryKeyFactory,
         ExecutionContext executionContext,
         boolean failOnMissingTables)
          throws 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:
    
    IOException
- Method Detail
  - getDatamodelFolder
```
public static String getDatamodelFolder(ExecutionContext executionContext)
```
    Gets name of data model folder.
  - getTablesFile
```
public static String getTablesFile(ExecutionContext executionContext)
```
    Gets name of file containing the table definitions.
  - getModelNameFile
```
public static String getModelNameFile(ExecutionContext executionContext)
```
    Gets name of file containing the model name
  - getDisplayNamesFile
```
public static String getDisplayNamesFile(ExecutionContext executionContext)
```
    Gets name of file containing the display names.
  - getColumnsFile
```
public static String getColumnsFile(ExecutionContext executionContext)
```
    Gets name of file containing the column definitions.
  - getAssociationsFile
```
public static String getAssociationsFile(ExecutionContext executionContext)
```
    Gets name of file containing the association definitions.
  - getExcludeFromDeletionFile
```
public static String getExcludeFromDeletionFile(ExecutionContext executionContext)
```
    List of tables to be excluded from deletion.
  - getVersionFile
```
public static String getVersionFile(ExecutionContext executionContext)
```
    Name of file containing the version number.
  - getTable
```
public Table getTable(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(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 String getName()
```
    Gets name of the model.
    
    Returns:
    name of the model
  - getLastModified
```
public Long getLastModified()
```
    Gets time of last modification.
    
    Returns:
    time of last modification
  - getDisplayName
```
public String getDisplayName(Table table)
```
    Gets display name of a table
    
    Parameters:
    table - the table
    
    Returns:
    the display name of the table
  - getTables
```
public 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 Set<Table> getIndependentTables(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 Set<Table> getIndependentTables(Set<Table> tableSet,
                              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 String toString()
```
    Stringifies the data model.
    
    Overrides:
    
    toString in class Object
  - getSortedTables
```
public List<Table> getSortedTables()
```
    Gets list of tables sorted by name.
    
    Returns:
    list of tables sorted by name
  - normalize
```
public Set<Table> normalize(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 String getExportModus()
```
    Gets export modus, SQL or XML. (GUI support).
  - setExportModus
```
public void setExportModus(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 void checkForPrimaryKey(Set<Table> subjects,
                      boolean forDeletion)
                        throws DataModel.NoPrimaryKeyException
```
    Checks whether all tables in the closure of a given subject have primary keys.
    
    Parameters:
    subject - the subject
    
    Throws:
    
    DataModel.NoPrimaryKeyException - if a table has no primary key
  - getParameters
```
public SortedSet<String> getParameters(String subjectCondition,
                              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 String getLastModifiedAsString()
```
    Gets getLastModified() as String.
    
    Returns:
    getLastModified() as String
  - save
```
public void save(String file,
        Table stable,
        String subjectCondition,
        ScriptFormat scriptFormat,
        List<RestrictionDefinition> restrictionDefinitions,
        Map<String,Map<String,double[]>> positions,
        List<ExtractionModel.AdditionalSubject> additionalSubjects,
        String currentModelSubfolder)
          throws FileNotFoundException
```
    Saves the data model.
    
    Parameters:
    file - the file name
    stable -
    stable - the subject table
    subjectCondition -
    scriptFormat -
    positions - table positions or null
    additionalSubjects -
    
    Throws:
    
    FileNotFoundException
  - saveRestrictions
```
public void saveRestrictions(File file,
                    List<RestrictionDefinition> restrictionDefinitions)
                      throws FileNotFoundException
```
    Saves restrictions only.
    
    Parameters:
    file - to save restrictions into
    
    Throws:
    
    FileNotFoundException
  - getTableByOrdinal
```
public Table getTableByOrdinal(int ordinal)
```
    Gets table by Table.getOrdinal().
    
    Parameters:
    ordinal - the ordinal
    
    Returns:
    the table
  - getFilterTemplates
```
public List<FilterTemplate> getFilterTemplates()
```
    Gets the FilterTemplates ordered by priority.
    
    Returns:
    template list
  - deriveFilters
```
public void deriveFilters()
```
    Removes all derived filters and renews them.

Class DataModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TABLE_CSV_FILE

MODELNAME_CSV_FILE

namedAssociations

version

DEFAULT_NAME

printClosures

Constructor Detail

DataModel

DataModel

DataModel

DataModel

DataModel

DataModel

DataModel

Method Detail

getDatamodelFolder

getTablesFile

getModelNameFile

getDisplayNamesFile

getColumnsFile

getAssociationsFile

getExcludeFromDeletionFile

getVersionFile

getTable

getTableByDisplayName

getName

getLastModified

getDisplayName

getTables

getRestrictionModel

setRestrictionModel

getIndependentTables

getIndependentTables

transpose

toString

getSortedTables

normalize

assignAssociationIDs

getExportModus

setExportModus

getXmlSettings

setXmlSettings

getVersion

checkForPrimaryKey

getParameters

getLastModifiedAsString

save

saveRestrictions

getTableByOrdinal

getFilterTemplates

deriveFilters