Package org.ametys.plugins.contentio.export.sql

Class CreateSqlTableComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentio.export.sql.CreateSqlTableComponent

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class CreateSqlTableComponent
extends AbstractLogEnabled
implements Component, Serviceable

Create SQl Table Component

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	Content type extension point.
protected I18nUtils	_i18nTranslator	The i18n translator.
protected LanguagesManager	_languageManager	The language manager
protected NormalizeNameComponent	_normalizeNameComponent	The normalise name component.
static final String	COLUMN_PARENT_TABLE_PREFIX	Prefix for parent table column
static final String	DEFAULT_LANGUAGE_CODE_FOR_COMMENTS	Code of default language for comments
static final String	MYSQL_CONTENT_EXPORT_CHARSET	The encoding
static final String	MYSQL_CONTENT_EXPORT_ENGINE	The engine
static final String	ROLE	The component role

Constructor Summary

Constructors

Constructor	Description
CreateSqlTableComponent()

Method Summary

Modifier and Type	Method	Description
protected void	_executeQueries(List<String> listQuery)	Execute query list
protected void	addAdditionalData(ContentType contentType, StringBuilder currentCreateTableSQLQuery, String tableName)	Add additionnal data for content (title, type, language, creator, creationDate, ....)
protected String	addColumn(StringBuilder currentCreateTableSQLQuery, String columnName, String tableName, String comment, String type)	Add a column
protected void	addColumnForContainer(ModelItemContainer modelItemContainer, StringBuilder currentCreateTableSQLQuery, String tableName, String columnNamePrefix)	Add all the column for each attribute in the ModelItemContainer.
protected void	addColumnForSingleAttribute(ElementDefinition definition, StringBuilder currentCreateTableSQLQuery, String tableName, String columnName)	Add column for single attribute
protected void	addColumnParentId(StringBuilder currentCreateTableSQLQuery, String tableParentName, String tableName)	Add an id column which refer to another table
protected void	addSortColumn(StringBuilder currentCreateTableSQLQuery, String tableName)	Add a column to sort
protected String	convertTypeToSql(String type)	Return the sql type corresponding to the attribute and the database type. Default to the sql type corresponding to "string" in case of unknown type.
protected String	createCommentQuery(String table, String column, String comments)	Create the query to add comment to a table or a column
protected void	createContentTable()	Create table for content
protected String	createEngineQuery()	Create the query to add engine
protected String	createForeignKeyQuery(String fkName, String tableName, String columnName)	Create the query to add foreign key
protected void	createMappingTables()	Create the two table mapping (for table name and column name)
protected String	createPrimaryKeyQuery()	Create the query to add primary key
protected void	createQueriesForTableCreation(ModelItemContainer modelItemContainer, String tableName, String tableParentName, String comment, boolean isSortTable)	Create SQL queries to create necessary SQL tables for content type export
protected void	createQueryForMultipleAttribute(ElementDefinition definition, String tableParentName, String tableName)	Create table for multiple attribute
protected void	createRichTextDataTable()	Create table for images in rich text
protected void	createTableForEnumerator(ElementDefinition definition, String tableParentName, String tableName, String columnName, StringBuilder currentCreateTableSQLQuery)	Create the table for the enumerator (key, value)
Map<String,ExportTableInfo>	createTables(ExportConfiguration exportConfiguration)	Create sql tables for contents
protected void	createTablesInfos(Map<String,String> contents)	Created all tables informations
protected void	executeQueries()	Execute SQL queries
protected void	fillMappingTables(String mappingTableName, String mappingColumnName)	Fill the two mapping table (for table name and column name)
protected void	fillTableForEnumerator(ElementDefinition definition, String tableName)	Fill values for the enumerator table
protected PreparedStatement	getInsertPreparedStatementFromTableName(String tableName)	Prepare INSERT statement
protected void	initialize(String productVersion)	Initialization
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role

DEFAULT_LANGUAGE_CODE_FOR_COMMENTS

public static final String DEFAULT_LANGUAGE_CODE_FOR_COMMENTS

Code of default language for comments

See Also:

• Constant Field Values

MYSQL_CONTENT_EXPORT_ENGINE

public static final String MYSQL_CONTENT_EXPORT_ENGINE

The engine

See Also:

• Constant Field Values

MYSQL_CONTENT_EXPORT_CHARSET

public static final String MYSQL_CONTENT_EXPORT_CHARSET

The encoding

See Also:

• Constant Field Values

COLUMN_PARENT_TABLE_PREFIX

public static final String COLUMN_PARENT_TABLE_PREFIX

Prefix for parent table column

See Also:

• Constant Field Values

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

Content type extension point.

_i18nTranslator

protected I18nUtils _i18nTranslator

The i18n translator.

_normalizeNameComponent

protected NormalizeNameComponent _normalizeNameComponent

The normalise name component.

_languageManager

protected LanguagesManager _languageManager

The language manager

Constructor Details

CreateSqlTableComponent

public CreateSqlTableComponent()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

createTables

public Map<String,ExportTableInfo> createTables(ExportConfiguration exportConfiguration)
                                         throws SQLException,
IOException

Create sql tables for contents

Parameters:

exportConfiguration - the content export configuration

Returns:

tablesInfos

Throws:

SQLException - if a sql error occurred

IOException - if an IO error occurred

initialize

protected void initialize(String productVersion)

Initialization

Parameters:

productVersion - The database product version

createTablesInfos

protected void createTablesInfos(Map<String,String> contents)
                          throws SQLException

Created all tables informations

Parameters:

contents - to export

Throws:

SQLException - if a sql error occurred

createQueriesForTableCreation

protected void createQueriesForTableCreation(ModelItemContainer modelItemContainer,
 String tableName,
 String tableParentName,
 String comment,
 boolean isSortTable)

Create SQL queries to create necessary SQL tables for content type export

Parameters:

modelItemContainer - the current ModelItemContainer

tableName - the table name The SQL table name

tableParentName - The SQL parent table name

comment - the comment

isSortTable - true if table's rows have to be ordered

createRichTextDataTable

protected void createRichTextDataTable()

Create table for images in rich text

createContentTable

protected void createContentTable()

Create table for content

createTableForEnumerator

protected void createTableForEnumerator(ElementDefinition definition,
 String tableParentName,
 String tableName,
 String columnName,
 StringBuilder currentCreateTableSQLQuery)

Create the table for the enumerator (key, value)

Parameters:

definition - the attribute definition

tableParentName - the table parent name

tableName - the table name

columnName - the column name

currentCreateTableSQLQuery - the current SQL create table query

fillTableForEnumerator

protected void fillTableForEnumerator(ElementDefinition definition,
 String tableName)

Fill values for the enumerator table

Parameters:

definition - the attribute definition

tableName - the table name

createMappingTables

protected void createMappingTables()

Create the two table mapping (for table name and column name)

fillMappingTables

protected void fillMappingTables(String mappingTableName,
 String mappingColumnName)

Fill the two mapping table (for table name and column name)

Parameters:

mappingTableName - the table mapping table name

mappingColumnName - the column mapping table name

addColumnForContainer

protected void addColumnForContainer(ModelItemContainer modelItemContainer,
 StringBuilder currentCreateTableSQLQuery,
 String tableName,
 String columnNamePrefix)

Add all the column for each attribute in the ModelItemContainer.

Parameters:

modelItemContainer - the attribute definitions

currentCreateTableSQLQuery - the current SQL create table query

tableName - the table name

columnNamePrefix - the column namePrefix

addColumnForSingleAttribute

protected void addColumnForSingleAttribute(ElementDefinition definition,
 StringBuilder currentCreateTableSQLQuery,
 String tableName,
 String columnName)

Add column for single attribute

Parameters:

definition - the attribute definition

currentCreateTableSQLQuery - the current SQL create table query

tableName - the table name

columnName - the column name

addColumn

protected String addColumn(StringBuilder currentCreateTableSQLQuery,
 String columnName,
 String tableName,
 String comment,
 String type)

Add a column

Parameters:

currentCreateTableSQLQuery - the current SQL create table query

tableName - the table name

columnName - the desired column name

comment - the column comment

type - the column type

Returns:

the actual column name, after normalization of the desired one

createQueryForMultipleAttribute

protected void createQueryForMultipleAttribute(ElementDefinition definition,
 String tableParentName,
 String tableName)

Create table for multiple attribute

Parameters:

definition - the attribute definition

tableParentName - the name of the table for the attribute's container

tableName - the table name

addAdditionalData

protected void addAdditionalData(ContentType contentType,
 StringBuilder currentCreateTableSQLQuery,
 String tableName)

Add additionnal data for content (title, type, language, creator, creationDate, ....)

Parameters:

contentType - the model

currentCreateTableSQLQuery - the current SQL create table query

tableName - the table name

addSortColumn

protected void addSortColumn(StringBuilder currentCreateTableSQLQuery,
 String tableName)

Add a column to sort

Parameters:

currentCreateTableSQLQuery - the current SQL create table query

tableName - the table name

addColumnParentId

protected void addColumnParentId(StringBuilder currentCreateTableSQLQuery,
 String tableParentName,
 String tableName)

Add an id column which refer to another table

Parameters:

currentCreateTableSQLQuery - the current SQL create table query

tableParentName - the table parent name

tableName - the table name

createCommentQuery

protected String createCommentQuery(String table,
 String column,
 String comments)

Create the query to add comment to a table or a column

Parameters:

table - the table name

column - the column name

comments - the comments

Returns:

the query to add comment to a table or a column

createForeignKeyQuery

protected String createForeignKeyQuery(String fkName,
 String tableName,
 String columnName)

Create the query to add foreign key

Parameters:

fkName - the foreign key name

tableName - the table name

columnName - the column name

Returns:

the query to add comment to a table or a column

createEngineQuery

protected String createEngineQuery()

Create the query to add engine

Returns:

the query to add engine

createPrimaryKeyQuery

protected String createPrimaryKeyQuery()

Create the query to add primary key

Returns:

the query to add primary key

convertTypeToSql

protected String convertTypeToSql(String type)

Return the sql type corresponding to the attribute and the database type.
Default to the sql type corresponding to "string" in case of unknown type.

Parameters:

type - the attribute's type

Returns:

the sql type

executeQueries

protected void executeQueries()
                       throws SQLException,
IOException

Execute SQL queries

Throws:

SQLException - if a sql error occurred

IOException - if an IO error occurred

_executeQueries

protected void _executeQueries(List<String> listQuery)
                        throws SQLException,
IOException

Execute query list

Parameters:

listQuery - the list of query to execute

Throws:

SQLException - if a sql error occurred

IOException - if an IO error occurred

getInsertPreparedStatementFromTableName

protected PreparedStatement getInsertPreparedStatementFromTableName(String tableName)
                                                             throws SQLException

Prepare INSERT statement

Parameters:

tableName - the table name

Returns:

the INSERT preparedStatement

Throws:

SQLException - if a sql error occurred