org.xmlBlaster.contrib.replication
Interface I_Mapper

All Superinterfaces:

I_ContribPlugin

All Known Implementing Classes:

DefaultMapper, SearchableConfig

public interface I_Mapper
extends I_ContribPlugin

Field Summary

static java.lang.String

COLUMN_TO_IGNORE

Method Summary

java.lang.String	getMappedCatalog(java.lang.String catalog, java.lang.String schema, java.lang.String table, java.lang.String column, java.lang.String def) Returns the mapped catalog or null.
java.lang.String	getMappedColumn(java.lang.String catalog, java.lang.String Schema, java.lang.String table, java.lang.String column, java.lang.String def) Gets the mapped column.
java.lang.String	getMappedSchema(java.lang.String catalog, java.lang.String schema, java.lang.String table, java.lang.String column, java.lang.String def) Returns the mapped schema or null.
java.lang.String	getMappedTable(java.lang.String catalog, java.lang.String schema, java.lang.String table, java.lang.String column, java.lang.String def) Gets the mapped table.
java.lang.String	getMappedType(java.lang.String catalog, java.lang.String Schema, java.lang.String table, java.lang.String column, java.lang.String type, java.lang.String def) This method is currently unused, and is here for future releases.

Methods inherited from interface org.xmlBlaster.contrib.I_ContribPlugin

getUsedPropertyKeys, init, shutdown

Field Detail

COLUMN_TO_IGNORE

static final java.lang.String COLUMN_TO_IGNORE

See Also:

Constant Field Values

Method Detail

getMappedCatalog

java.lang.String getMappedCatalog(java.lang.String catalog,
                                  java.lang.String schema,
                                  java.lang.String table,
                                  java.lang.String column,
                                  java.lang.String def)

Returns the mapped catalog or null.

Parameters:

catalog - The catalog name of the source (the master catalog). Null is allowed and means unspecified.

schema - The schema name of the source (the master). Null is allowed and means unspecified.

table - The table name of the source. On null it is considered a default.

column - The column name of the source. On null it is considered a default.

def - the default value if no entry has been found.

Returns:

the catalog name of the destination (the slave catalog), or null which means that catalog info will not be used on the destination.

getMappedSchema

java.lang.String getMappedSchema(java.lang.String catalog,
                                 java.lang.String schema,
                                 java.lang.String table,
                                 java.lang.String column,
                                 java.lang.String def)

Returns the mapped schema or null.

Parameters:

catalog - The catalog name of the source (the master). Null is allowed and means unspecified.

schema - The schema name of the source (the master). Null is allowed and means unspecified.

table - The table name of the source. On null it is considered a default.

column - The column name of the source. On null it is considered a default.

def - the default value if no entry has been found.

Returns:

the schema name of the destination (the slave), or null which means that schema info will not be used on the destination.

getMappedTable

java.lang.String getMappedTable(java.lang.String catalog,
                                java.lang.String schema,
                                java.lang.String table,
                                java.lang.String column,
                                java.lang.String def)

Gets the mapped table.

Parameters:

catalog - The catalog name of the source (the master). Null is allowed and means unspecified.

schema - The schema name of the source (the master). Null is allowed and means unspecified.

table - The table name of the source. On null the behaviour is unspecified and implementation dependant.

column - The column name of the source. On null the behaviour is unspecified and implementation dependant.

def - the default value if no entry has been found.

Returns:

the table name to be used on the slave. If null it means that this table is not further processed.

getMappedColumn

java.lang.String getMappedColumn(java.lang.String catalog,
                                 java.lang.String Schema,
                                 java.lang.String table,
                                 java.lang.String column,
                                 java.lang.String def)

Gets the mapped column.

Parameters:

catalog - The catalog name of the source (the master). Null is allowed and means unspecified.

schema - The schema name of the source (the master). Null is allowed and means unspecified.

table - The table name of the source. On null the behaviour is unspecified and implementation dependant.

column - The column name of the source. On null the behaviour is unspecified and implementation dependant.

def - the default value if no entry has been found.

Returns:

the table name to be used on the slave. If null it means that this table is not further processed.

getMappedType

java.lang.String getMappedType(java.lang.String catalog,
                               java.lang.String Schema,
                               java.lang.String table,
                               java.lang.String column,
                               java.lang.String type,
                               java.lang.String def)

This method is currently unused, and is here for future releases.

Parameters:

catalog - The catalog name of the source (the master). Null is allowed and means unspecified.

schema - The schema name of the source (the master). Null is allowed and means unspecified.

table - The table name of the source. On null the behaviour is unspecified and implementation dependant.

column - The column name of the source. On null the behaviour is unspecified and implementation dependant.

def - the default value if no entry has been found.

type -

Returns: