com.im.df.api.capabilities
Interface JChemSchemaCapability

All Superinterfaces:

DBSchemaCapability, DFCapability

public interface JChemSchemaCapability
extends DBSchemaCapability

Schema's capability specially for JChem structure tables. This interface allows to manage JChem Properties tables in the database. Proeprty tables are Chemaxon JChemBase metadata tables in database which contain metadata for each table (JChem DFEntity) containing structures.

Field Summary

static String

PROP_JCHEM_PROPERTY_TABLES

Fields inherited from interface com.im.df.api.capabilities.DBSchemaCapability

PROP_EXTRA_SCHEMAS, PROP_SUPPLEMENTAL_TABLES, PROP_TABLES, PROP_VIEWS, XATTR_SCHEMA_LOGGING

Method Summary

void	createJChemPropertyTable(String name, Map<String,String> props, DFEnvironmentRW env) Deprecated. Use the form that takes the db schema name as an argument
void	createJChemPropertyTable(String dbSchemaName, String name, Map<String,String> props, DFEnvironmentRW env) Create a new property table and add it to the list we know about
Set<String>	getAssociatedTables(SchemaQualifiedName schemaPlusProptable) Finds which structure tables are associated with the property table.
Set<String>	getJChemPropertyTables() Returns all known JChem Property table names in any schema.
Set<String>	getJChemPropertyTables(String dbSchemaName) Returns all known JChem Property table names.
boolean	isJChemBaseTable(String tableName) Deprecated. Use the form that takes the db schema name as an argument
boolean	isJChemBaseTable(String dbSchemaName, String tableName) Is this table a JChemBase table
boolean	isJChemCartJChemBaseTable(String tableName) Deprecated. Use the form that takes the db schema name as an argument
boolean	isJChemCartJChemBaseTable(String dbSchemaName, String tableName) Is this table a cartridge table using a JChemBase table
boolean	isJChemCartStandardTable(String tableName) Deprecated. Use the form that takes the db schema name as an argument
boolean	isJChemCartStandardTable(String dbSchemaName, String tableName) Is this table a cartridge table using a standard table
boolean	isJChemPropertyTable(String tableName) Deprecated. Use the form that takes the db schema name as an argument
boolean	isJChemPropertyTable(String dbSchemaName, String tableName) Does this property table exist in the database
void	removeJChemPropertyTable(String tableName, DFEnvironmentRW env) Deprecated. Use the form that takes the db schema name as an argument
void	removeJChemPropertyTable(String dbSchemaName, String tableName, DFEnvironmentRW env) Removes this property table from the database.

Methods inherited from interface com.im.df.api.capabilities.DBSchemaCapability

claimTableOwnership, getAllManagedTableInfos, getAllSchemas, getAllTableInfos, getAllTableNames, getAllTableNames, getAllViewInfos, getAllViewNames, getAllViewNames, getConstraintNames, getDatabaseType, getDefaultDBSchemaName, getExtraSchemas, getManagedTables, getManagedTables, getMaxColumnNameLength, getMaxIndexNameLength, getMaxTableNameLength, getPerformanceMode, getPreviousPerformanceMode, getSystemTables, getTableInfo, getTableInfo, getTableInfo, getUnsupportedDatabaseOperations, isSupportingDBSchemas, removeTable, setExtraSchemas, setPerformanceMode

Field Detail

PROP_JCHEM_PROPERTY_TABLES

static final String PROP_JCHEM_PROPERTY_TABLES

See Also:

Constant Field Values

Method Detail

getJChemPropertyTables

Set<String> getJChemPropertyTables()

Returns all known JChem Property table names in any schema. The names returned are schema qualified table names

getJChemPropertyTables

Set<String> getJChemPropertyTables(String dbSchemaName)

Returns all known JChem Property table names. The names are NOT schema qualified

Parameters:

dbSchemaName - The name of the database schema (not to be confused with the name of this IJC schema). Will be null for databases that do not support schemas.

getAssociatedTables

Set<String> getAssociatedTables(SchemaQualifiedName schemaPlusProptable)

Finds which structure tables are associated with the property table. The property table should not be removed before all such tables are dropped (e.g. entities deleted).

Parameters:

schemaPlusProptable - Sceham qualified name of the JChem property table

Returns:

JChem tables associated with the property table. Null if there are no tables.

createJChemPropertyTable

void createJChemPropertyTable(String name,
                              Map<String,String> props,
                              DFEnvironmentRW env)

Deprecated. Use the form that takes the db schema name as an argument

Create a new property table in the default database schema and add it to the list we know about

Parameters:

name - The name for the property table

createJChemPropertyTable

void createJChemPropertyTable(String dbSchemaName,
                              String name,
                              Map<String,String> props,
                              DFEnvironmentRW env)

Create a new property table and add it to the list we know about

Parameters:

dbSchemaName - The name of the database schema (not to be confused with the name of this IJC schema). Will be null for databases that do not support schemas.

name - The name for the property table

removeJChemPropertyTable

void removeJChemPropertyTable(String tableName,
                              DFEnvironmentRW env)

Deprecated. Use the form that takes the db schema name as an argument

Removes this property table from the default schema of the database. The table must not be used by any existing JChem Entity.

Parameters:

env -

tableName - The name for the JChemProperty table

removeJChemPropertyTable

void removeJChemPropertyTable(String dbSchemaName,
                              String tableName,
                              DFEnvironmentRW env)

Removes this property table from the database. The table must not be used by any existing JChem Entity.

Parameters:

dbSchemaName - The name of the database schema (not to be confused with the name of this IJC schema). Will be null for databases that do not support schemas.

env -

tableName - The name for the JChemProperty table

isJChemPropertyTable

boolean isJChemPropertyTable(String tableName)

Deprecated. Use the form that takes the db schema name as an argument

Does this property table exist in the default schema of the database

Parameters:

tableName -

Returns:

Is the property table present

isJChemPropertyTable

boolean isJChemPropertyTable(String dbSchemaName,
                             String tableName)

Does this property table exist in the database

Parameters:

dbSchemaName - The name of the database schema (not to be confused with the name of this IJC schema). Will be null for databases that do not support schemas.

tableName -

Returns:

Is the property table present

isJChemBaseTable

boolean isJChemBaseTable(String tableName)

Deprecated. Use the form that takes the db schema name as an argument

Is this table a JChemBase table in the default database schema

Parameters:

tableName - The table name

isJChemBaseTable

boolean isJChemBaseTable(String dbSchemaName,
                         String tableName)

Is this table a JChemBase table

Parameters:

dbSchemaName - The name of the database schema (not to be confused with the name of this IJC schema). Will be null for databases that do not support schemas.

tableName - The table name

isJChemCartJChemBaseTable

boolean isJChemCartJChemBaseTable(String tableName)

Deprecated. Use the form that takes the db schema name as an argument

Is this table a cartridge table using a JChemBase table in the default database schema

Parameters:

tableName - The table name

isJChemCartJChemBaseTable

boolean isJChemCartJChemBaseTable(String dbSchemaName,
                                  String tableName)

Is this table a cartridge table using a JChemBase table

Parameters:

dbSchemaName - The name of the database schema (not to be confused with the name of this IJC schema). Will be null for databases that do not support schemas.

tableName - The table name

isJChemCartStandardTable

boolean isJChemCartStandardTable(String tableName)

Deprecated. Use the form that takes the db schema name as an argument

Is this table a cartridge table using a standard table in the default database schema

Parameters:

tableName - The table name

isJChemCartStandardTable

boolean isJChemCartStandardTable(String dbSchemaName,
                                 String tableName)

Is this table a cartridge table using a standard table

Parameters:

dbSchemaName - The name of the database schema (not to be confused with the name of this IJC schema). Will be null for databases that do not support schemas.

tableName - The table name