SynchroTableMetadata (SIH-Adagio :: Synchronization 3.5.6 API)

Object
- SynchroTableMetadata

```
public class SynchroTableMetadata
extends Object
```
Overrides of the TableMetadata with some improvements:
- Obtains number of columns via getColumnsCount()
- Obtains all columns names available via getColumnNames()
- Obtains primary key column names via getPkNames()
And others methods used to synchronize referentials:
- Obtains query to update a row of the table (column names order is the one introduced by method getColumnNames(): getUpdateQuery()
- Obtains query to insert a row in the table (column names order is the one introduced by method getColumnNames(): getInsertQuery()
Created on 1/14/14.
Since:

3.0

Author:

Tony Chemit

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SynchroTableMetadata.TableInsertStrategy

Nested Classes
Modifier and Type	Class and Description
`static class`	`SynchroTableMetadata.TableInsertStrategy`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<SynchroJoinMetadata>`	`childJoins`
`static String`	`COLUMN_ID`
`static String`	`COLUMN_REMOTE_ID`
`static String`	`COLUMN_SYNCHRONIZATION_STATUS`
`static String`	`COLUMN_UPDATE_DATE`
`protected List<String>`	`columnNames`
`protected Map<String,SynchroColumnMetadata>`	`columns`
`protected SynchroContext`	`context`
`protected String`	`countDataToUpdateQuery`
`protected String`	`countQuery`
`protected SynchroDatabaseMetadata`	`dbMeta`
`protected TableMetadata`	`delegate`
`protected boolean`	`hasChildJoins`
`protected boolean`	`hasJoins`
`protected String`	`insertQuery`
`protected SynchroTableMetadata.TableInsertStrategy`	`insertStrategy`
`protected String`	`insertWithGeneratedIdQuery`
`protected List<SynchroInterceptor>`	`interceptors`
`protected boolean`	`isRoot`
`protected List<SynchroJoinMetadata>`	`joins`
`protected List<SynchroJoinMetadata>`	`parentJoins`
`static String`	`PK_SEPARATOR`
`protected int[]`	`pkIndexs`
`protected Set<String>`	`pkNames`
`static Set<String>`	`PROTECTED_COLUMN_NAMES`
`protected List<String>`	`protectedColumnNames`
`protected String`	`selectAllQuery`
`protected Map<String,String>`	`selectDataFromFkQueries`
`protected Map<String,String>`	`selectDataFromFkQueriesBigParams`
`protected String`	`selectDataQueryFromPk`
`protected String`	`selectDataToUpdateQuery`
`protected String`	`selectIdFromRemoteIdQuery`
`protected String`	`selectMaxUpdateDateQuery`
`protected String`	`selectPrimaryKeysAsStringQuery`
`protected String`	`selectPrimaryKeysQuery`
`protected String`	`selectRemoteIdsQuery`
`protected String`	`selectSequenceNextValueString`
`static String`	`SEQUENCE_SUFFIX`
`protected String`	`sequenceName`
`protected String`	`sequenceNextValString`
`protected String`	`updateQuery`
`protected boolean`	`withIdColumn`
`protected boolean`	`withRemoteIdColumn`
`protected boolean`	`withSynchronizationStatusColumn`
`protected boolean`	`withUpdateDateColumn`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SynchroTableMetadata(SynchroDatabaseMetadata dbMeta, TableMetadata delegate, List<SynchroInterceptor> interceptors, String tableName, Set<String> availableSequences, Predicate<SynchroColumnMetadata> columnFilter)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected String`	`createCountDataToUpdateQuery()`
`protected String`	`createCountQuery()`
`protected String`	`createInsertQuery()`
`protected String`	`createInsertQuery(boolean generateId)`
`protected String`	`createInsertWithGeneratedIdQuery()`
`protected int[]`	`createPkIndex()`
`protected String`	`createPkWhereClause()`
`protected String`	`createSelectAllQuery()`
`protected Map<String,String>`	`createSelectDataFromFkQueries()`
`protected Map<String,String>`	`createSelectDataFromFkQueriesBigParams(SynchroDatabaseMetadata dbMeta)`
`protected String`	`createSelectDataFromPkQuery()`
`protected String`	`createSelectDataToUpdateQuery()`
`protected String`	`createSelectIdFromRemoteIdQuery()`
`protected String`	`createSelectMaxUpdateDateQuery()`
`protected String`	`createSelectParams()`
`protected String`	`createSelectParams(String tableAlias)`
`protected String`	`createSelectPrimaryKeysAsStringQuery()`
`protected String`	`createSelectPrimaryKeysQuery()`
`protected String`	`createSelectRemoteIdsQuery()`
`protected String`	`createSelectSequenceNextValString(Dialect dialect)`
`protected String`	`createSequenceNextValString(Dialect dialect)`
`protected String`	`createUpdateQuery()`
`protected String`	`createWithUpdateDateWhereClause()`
`protected String`	`createWithUpdateDateWhereClause(String tableAlias)`
`protected String`	`fireOnCreateSelectQuery(String queryName, String sql)`
`protected void`	`fireOnJoinLoad(SynchroJoinMetadata join)`
`List<Object>`	`fromPkStr(String pk)`
`String`	`getCatalog()`
`List<SynchroJoinMetadata>`	`getChildJoins()`
`SynchroColumnMetadata`	`getColumn(String columnName)`
`int`	`getColumnIndex(String name)`
`SynchroColumnMetadata`	`getColumnMetadata(String columnName)`
`Set<String>`	`getColumnNames()`
`static Map<String,ColumnMetadata>`	`getColumns(TableMetadata delegate)`
`int`	`getColumnsCount()`
`String`	`getCountDataToUpdateQuery(Date fromDate)`
`String`	`getCountQuery()`
`Object[]`	`getData(ResultSet incomingData)`
`SynchroDatabaseMetadata`	`getDatabaseMetadata()`
`TableMetadata`	`getDelegate()`
`ForeignKeyMetadata`	`getForeignKeyMetadata(ForeignKey fk)`
`ForeignKeyMetadata`	`getForeignKeyMetadata(String keyName)`
`Integer`	`getId(ResultSet incomingData)`
`IndexMetadata`	`getIndexMetadata(String indexName)`
`String`	`getInsertQuery()`
`SynchroTableMetadata.TableInsertStrategy`	`getInsertStrategy()`
`String`	`getInsertWithGeneratedIdQuery()`
`List<SynchroInterceptor>`	`getInterceptors()`
`List<SynchroJoinMetadata>`	`getJoins()`
`String`	`getName()`
`Object`	`getObject(ResultSet incomingData, int index)`
`List<SynchroJoinMetadata>`	`getParentJoins()`
`List<Object>`	`getPk(Object[] incomingData)`
`List<Object>`	`getPk(ResultSet incomingData)`
`int[]`	`getPkIndexs()`
`Set<String>`	`getPkNames()`
`String`	`getSchema()`
`String`	`getSelectDataFromFkQuery(String columnName, int nbValues)`
`String`	`getSelectDataFromFkQueryBigParams(String columnName)`
`String`	`getSelectDataQueryFromPk()`
`String`	`getSelectDataToUpdateQuery(Date fromDate)`
`String`	`getSelectIdFromRemoteIdQuery(String tableName)`
`String`	`getSelectMaxUpdateDateQuery()`
`String`	`getSelectPrimaryKeysAsStringQuery()` Obtains a SQL with one column output : a concatenation of all PK.
`String`	`getSelectPrimaryKeysQuery()`
`String`	`getSelectRemoteIdsQuery()`
`String`	`getSequenceNextValString()`
`String`	`getTableLogPrefix()`
`String`	`getUpdateQuery()`
`boolean`	`hasChildJoins()`
`boolean`	`hasJoins()`
`protected List<SynchroJoinMetadata>`	`initChildJoins(List<SynchroJoinMetadata> joins)`
`protected List<String>`	`initColumnNames(Map<String,SynchroColumnMetadata> columns)`
`protected Map<String,SynchroColumnMetadata>`	`initColumns(String tableName, SynchroDatabaseMetadata dbMeta, Predicate<SynchroColumnMetadata> columnFilter)`
`protected List<SynchroJoinMetadata>`	`initJoins(String tableName, SynchroDatabaseMetadata dbMeta, Map<String,SynchroColumnMetadata> columns, List<SynchroInterceptor> interceptors)`
`void`	`initJoins(SynchroDatabaseMetadata dbMeta)` Initialize Join metadata. this need to have already loaded all tables.
`protected List<SynchroJoinMetadata>`	`initParentJoins(List<SynchroJoinMetadata> joins)`
`protected Set<String>`	`initPrimaryKeys(SynchroDatabaseMetadata dbMeta)`
`protected List<String>`	`initProtectedColumnNames(Map<String,SynchroColumnMetadata> columns)`
`protected String`	`initSequenceName(Set<String> availableSequences)`
`boolean`	`isRoot()`
`boolean`	`isSelectPrimaryKeysAsStringQueryEnable()`
`boolean`	`isSimpleKey()`
`boolean`	`isWithIdColumn()`
`boolean`	`isWithRemoteIdColumn()`
`boolean`	`isWithSynchronizationStatusColumn()`
`boolean`	`isWithUpdateDateColumn()`
`void`	`setIsRoot(boolean isRoot)`
`String`	`toPkStr(List<Object> pkList)` Serialize into a String a list of PK value.
`String`	`toString()`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PK_SEPARATOR

public static final String PK_SEPARATOR

See Also:: Constant Field Values

COLUMN_SYNCHRONIZATION_STATUS

public static final String COLUMN_SYNCHRONIZATION_STATUS

See Also:: Constant Field Values

COLUMN_ID
```
public static final String COLUMN_ID
```
See Also:
Constant Field Values

COLUMN_REMOTE_ID

public static final String COLUMN_REMOTE_ID

See Also:: Constant Field Values

COLUMN_UPDATE_DATE

public static final String COLUMN_UPDATE_DATE

See Also:: Constant Field Values

SEQUENCE_SUFFIX

public static final String SEQUENCE_SUFFIX

See Also:: Constant Field Values

PROTECTED_COLUMN_NAMES

public static Set<String> PROTECTED_COLUMN_NAMES

selectPrimaryKeysAsStringQuery

protected final String selectPrimaryKeysAsStringQuery

selectPrimaryKeysQuery

protected final String selectPrimaryKeysQuery

selectMaxUpdateDateQuery

protected final String selectMaxUpdateDateQuery

countQuery
```
protected final String countQuery
```

delegate
```
protected final TableMetadata delegate
```

columns

protected final Map<String,SynchroColumnMetadata> columns

childJoins

protected List<SynchroJoinMetadata> childJoins

parentJoins

protected List<SynchroJoinMetadata> parentJoins

joins

protected List<SynchroJoinMetadata> joins

hasJoins
```
protected boolean hasJoins
```

hasChildJoins
```
protected boolean hasChildJoins
```

protectedColumnNames

protected final List<String> protectedColumnNames

columnNames

protected final List<String> columnNames

pkNames
```
protected final Set<String> pkNames
```

pkIndexs
```
protected final int[] pkIndexs
```

insertQuery
```
protected String insertQuery
```

insertWithGeneratedIdQuery

protected String insertWithGeneratedIdQuery

updateQuery
```
protected String updateQuery
```

withUpdateDateColumn

protected final boolean withUpdateDateColumn

withSynchronizationStatusColumn

protected final boolean withSynchronizationStatusColumn

withIdColumn
```
protected final boolean withIdColumn
```

withRemoteIdColumn

protected final boolean withRemoteIdColumn

isRoot
```
protected boolean isRoot
```

countDataToUpdateQuery

protected final String countDataToUpdateQuery

selectDataToUpdateQuery

protected final String selectDataToUpdateQuery

sequenceName
```
protected final String sequenceName
```

selectSequenceNextValueString

protected final String selectSequenceNextValueString

sequenceNextValString

protected final String sequenceNextValString

selectAllQuery
```
protected final String selectAllQuery
```

selectDataQueryFromPk

protected final String selectDataQueryFromPk

selectDataFromFkQueries

protected final Map<String,String> selectDataFromFkQueries

selectDataFromFkQueriesBigParams

protected final Map<String,String> selectDataFromFkQueriesBigParams

selectIdFromRemoteIdQuery

protected final String selectIdFromRemoteIdQuery

selectRemoteIdsQuery

protected final String selectRemoteIdsQuery

interceptors

protected List<SynchroInterceptor> interceptors

context
```
protected final SynchroContext context
```

insertStrategy

protected SynchroTableMetadata.TableInsertStrategy insertStrategy

dbMeta

protected final SynchroDatabaseMetadata dbMeta

Constructor Detail

SynchroTableMetadata

protected SynchroTableMetadata(SynchroDatabaseMetadata dbMeta,
                    TableMetadata delegate,
                    List<SynchroInterceptor> interceptors,
                    String tableName,
                    Set<String> availableSequences,
                    Predicate<SynchroColumnMetadata> columnFilter)

Method Detail

getColumns

public static Map<String,ColumnMetadata> getColumns(TableMetadata delegate)

initJoins
```
public void initJoins(SynchroDatabaseMetadata dbMeta)
```
Initialize Join metadata. this need to have already loaded all tables.

Parameters:
dbMeta - the Database metadata, with some preloaded tables inside

getPkNames
```
public Set<String> getPkNames()
```

isWithUpdateDateColumn

public boolean isWithUpdateDateColumn()

isWithSynchronizationStatusColumn

public boolean isWithSynchronizationStatusColumn()

isWithIdColumn
```
public boolean isWithIdColumn()
```

isWithRemoteIdColumn
```
public boolean isWithRemoteIdColumn()
```

isRoot
```
public boolean isRoot()
```

getColumnsCount
```
public int getColumnsCount()
```

getColumnNames
```
public Set<String> getColumnNames()
```

getColumnIndex

public int getColumnIndex(String name)

getDelegate
```
public TableMetadata getDelegate()
```

getDatabaseMetadata

public SynchroDatabaseMetadata getDatabaseMetadata()

getName
```
public String getName()
```

getForeignKeyMetadata

public ForeignKeyMetadata getForeignKeyMetadata(ForeignKey fk)

getColumnMetadata

public SynchroColumnMetadata getColumnMetadata(String columnName)

getSchema
```
public String getSchema()
```

getCatalog
```
public String getCatalog()
```

getForeignKeyMetadata

public ForeignKeyMetadata getForeignKeyMetadata(String keyName)

getIndexMetadata

public IndexMetadata getIndexMetadata(String indexName)

getColumn

public SynchroColumnMetadata getColumn(String columnName)

getJoins

public List<SynchroJoinMetadata> getJoins()

getChildJoins

public List<SynchroJoinMetadata> getChildJoins()

getParentJoins

public List<SynchroJoinMetadata> getParentJoins()

hasJoins
```
public boolean hasJoins()
```

hasChildJoins
```
public boolean hasChildJoins()
```

getTableLogPrefix
```
public String getTableLogPrefix()
```

getInsertStrategy

public SynchroTableMetadata.TableInsertStrategy getInsertStrategy()

toString
```
public String toString()
```
Overrides:

toString in class Object

getInsertQuery
```
public String getInsertQuery()
```

getInsertWithGeneratedIdQuery

public String getInsertWithGeneratedIdQuery()

getUpdateQuery
```
public String getUpdateQuery()
```

getSelectPrimaryKeysAsStringQuery
```
public String getSelectPrimaryKeysAsStringQuery()
```
Obtains a SQL with one column output : a concatenation of all PK.

Returns:
a SQL select, with only one result column

getSelectPrimaryKeysQuery

public String getSelectPrimaryKeysQuery()

getSelectRemoteIdsQuery

public String getSelectRemoteIdsQuery()

getSequenceNextValString

public String getSequenceNextValString()

getSelectMaxUpdateDateQuery

public String getSelectMaxUpdateDateQuery()

getSelectDataQueryFromPk

public String getSelectDataQueryFromPk()

getSelectDataToUpdateQuery

public String getSelectDataToUpdateQuery(Date fromDate)

getSelectDataFromFkQuery

public String getSelectDataFromFkQuery(String columnName,
                              int nbValues)

getSelectDataFromFkQueryBigParams

public String getSelectDataFromFkQueryBigParams(String columnName)

getCountQuery
```
public String getCountQuery()
```

getCountDataToUpdateQuery

public String getCountDataToUpdateQuery(Date fromDate)

getSelectIdFromRemoteIdQuery

public String getSelectIdFromRemoteIdQuery(String tableName)

getData

public Object[] getData(ResultSet incomingData)
                 throws SQLException

Throws:: SQLException

getObject

public Object getObject(ResultSet incomingData,
               int index)
                 throws SQLException

Throws:: SQLException

getPkIndexs
```
public int[] getPkIndexs()
```

isSimpleKey
```
public boolean isSimpleKey()
```

getPk

public List<Object> getPk(ResultSet incomingData)
                   throws SQLException

Throws:: SQLException

isSelectPrimaryKeysAsStringQueryEnable

public boolean isSelectPrimaryKeysAsStringQueryEnable()

getPk

public List<Object> getPk(Object[] incomingData)
                   throws SQLException

Throws:: SQLException

getId

public Integer getId(ResultSet incomingData)
              throws SQLException

Throws:: SQLException

toPkStr
```
public String toPkStr(List<Object> pkList)
```
Serialize into a String a list of PK value. Usefull when more than one PK column in a table

Parameters:
pkList -

Returns:

fromPkStr

public List<Object> fromPkStr(String pk)

initColumns

protected Map<String,SynchroColumnMetadata> initColumns(String tableName,
                                            SynchroDatabaseMetadata dbMeta,
                                            Predicate<SynchroColumnMetadata> columnFilter)
                                                 throws NoSuchFieldException,
                                                        SecurityException,
                                                        IllegalArgumentException,
                                                        IllegalAccessException

Throws:: NoSuchFieldException; SecurityException; IllegalArgumentException; IllegalAccessException

initProtectedColumnNames

protected List<String> initProtectedColumnNames(Map<String,SynchroColumnMetadata> columns)

initColumnNames

protected List<String> initColumnNames(Map<String,SynchroColumnMetadata> columns)

initPrimaryKeys

protected Set<String> initPrimaryKeys(SynchroDatabaseMetadata dbMeta)
                               throws SQLException

Throws:: SQLException

createPkIndex
```
protected int[] createPkIndex()
```

initJoins

protected List<SynchroJoinMetadata> initJoins(String tableName,
                                  SynchroDatabaseMetadata dbMeta,
                                  Map<String,SynchroColumnMetadata> columns,
                                  List<SynchroInterceptor> interceptors)
                                       throws SQLException

Throws:: SQLException

initChildJoins

protected List<SynchroJoinMetadata> initChildJoins(List<SynchroJoinMetadata> joins)
                                            throws SQLException

Throws:: SQLException

initParentJoins

protected List<SynchroJoinMetadata> initParentJoins(List<SynchroJoinMetadata> joins)
                                             throws SQLException

Throws:: SQLException

createInsertQuery
```
protected String createInsertQuery()
```

createInsertWithGeneratedIdQuery

protected String createInsertWithGeneratedIdQuery()

createInsertQuery

protected String createInsertQuery(boolean generateId)

createUpdateQuery
```
protected String createUpdateQuery()
```

createSelectDataFromPkQuery

protected String createSelectDataFromPkQuery()

createSelectDataFromFkQueries

protected Map<String,String> createSelectDataFromFkQueries()

createSelectDataFromFkQueriesBigParams

protected Map<String,String> createSelectDataFromFkQueriesBigParams(SynchroDatabaseMetadata dbMeta)

createSelectPrimaryKeysAsStringQuery

protected String createSelectPrimaryKeysAsStringQuery()

createSelectPrimaryKeysQuery

protected String createSelectPrimaryKeysQuery()

createSelectRemoteIdsQuery

protected String createSelectRemoteIdsQuery()

createSelectAllQuery

protected String createSelectAllQuery()

createSelectMaxUpdateDateQuery

protected String createSelectMaxUpdateDateQuery()

createSelectDataToUpdateQuery

protected String createSelectDataToUpdateQuery()

createCountQuery
```
protected String createCountQuery()
```

createSelectIdFromRemoteIdQuery

protected String createSelectIdFromRemoteIdQuery()

createCountDataToUpdateQuery

protected String createCountDataToUpdateQuery()

createPkWhereClause

protected String createPkWhereClause()

createWithUpdateDateWhereClause

protected String createWithUpdateDateWhereClause()

createWithUpdateDateWhereClause

protected String createWithUpdateDateWhereClause(String tableAlias)

createSelectParams
```
protected String createSelectParams()
```

createSelectParams

protected String createSelectParams(String tableAlias)

initSequenceName

protected String initSequenceName(Set<String> availableSequences)

setIsRoot

public void setIsRoot(boolean isRoot)

createSelectSequenceNextValString

protected String createSelectSequenceNextValString(Dialect dialect)

createSequenceNextValString

protected String createSequenceNextValString(Dialect dialect)

getInterceptors

public List<SynchroInterceptor> getInterceptors()

fireOnCreateSelectQuery

protected String fireOnCreateSelectQuery(String queryName,
                             String sql)

fireOnJoinLoad

protected void fireOnJoinLoad(SynchroJoinMetadata join)

Class SynchroTableMetadata

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

PK_SEPARATOR

COLUMN_SYNCHRONIZATION_STATUS

COLUMN_ID

COLUMN_REMOTE_ID

COLUMN_UPDATE_DATE

SEQUENCE_SUFFIX

PROTECTED_COLUMN_NAMES

selectPrimaryKeysAsStringQuery

selectPrimaryKeysQuery

selectMaxUpdateDateQuery

countQuery

delegate

columns

childJoins

parentJoins

joins

hasJoins

hasChildJoins

protectedColumnNames

columnNames

pkNames

pkIndexs

insertQuery

insertWithGeneratedIdQuery

updateQuery

withUpdateDateColumn

withSynchronizationStatusColumn

withIdColumn

withRemoteIdColumn

isRoot

countDataToUpdateQuery

selectDataToUpdateQuery

sequenceName

selectSequenceNextValueString

sequenceNextValString

selectAllQuery

selectDataQueryFromPk

selectDataFromFkQueries

selectDataFromFkQueriesBigParams

selectIdFromRemoteIdQuery

selectRemoteIdsQuery

interceptors

context

insertStrategy

dbMeta

Constructor Detail

SynchroTableMetadata

Method Detail

getColumns

initJoins

getPkNames

isWithUpdateDateColumn

isWithSynchronizationStatusColumn

isWithIdColumn

isWithRemoteIdColumn

isRoot

getColumnsCount

getColumnNames

getColumnIndex

getDelegate

getDatabaseMetadata

getName

getForeignKeyMetadata

getColumnMetadata

getSchema

getCatalog

getForeignKeyMetadata

getIndexMetadata

getColumn

getJoins

getChildJoins

getParentJoins

hasJoins