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 Detail

      • PROP_JCHEM_PROPERTY_TABLES

        static final java.lang.String PROP_JCHEM_PROPERTY_TABLES
        See Also:
        Constant Field Values
    • Method Detail

      • getJChemPropertyTables

        java.util.Set<java.lang.String> getJChemPropertyTables()
        Returns all known JChem Property table names in any schema. The names returned are schema qualified table names
      • getJChemPropertyTables

        java.util.Set<java.lang.String> getJChemPropertyTables​(java.lang.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

        java.util.Set<java.lang.String> getAssociatedTables​(com.im.commons.db.util.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​(java.lang.String name,
                                      java.util.Map<java.lang.String,​java.lang.String> props,
                                      com.im.commons.progress.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​(java.lang.String dbSchemaName,
                                      java.lang.String name,
                                      java.util.Map<java.lang.String,​java.lang.String> props,
                                      com.im.commons.progress.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​(java.lang.String tableName,
                                      com.im.commons.progress.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​(java.lang.String dbSchemaName,
                                      java.lang.String tableName,
                                      com.im.commons.progress.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​(java.lang.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​(java.lang.String dbSchemaName,
                                     java.lang.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​(java.lang.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​(java.lang.String dbSchemaName,
                                 java.lang.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​(java.lang.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​(java.lang.String dbSchemaName,
                                          java.lang.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​(java.lang.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​(java.lang.String dbSchemaName,
                                         java.lang.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