// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.sql;

import java.sql.*;
import java.util.*;

import org.litesoft.db.*;
import org.litesoft.orsup.base.*;

public interface SQLProductSpecificHelper
{
    public void initializeDB( Connection pConnection, DBinfo pDBinfo, SQLIndexColumnsLocator pIndexColumnsLocator )
            throws SQLException;

    public void addColumnType( StringBuilder pCmd, SimpleColumnDefinitionExtended pSCD );

    /**
     * @param pProductVersion       - Of The DataBase
     * @param pTableName            - Of the Schema's Table Name
     * @param pSelectColumns        - Of the Table (comma separated)
     * @param pSelectionWhereClause - null means all
     * @param pOrderBy              - null means order immaterial
     * @param pOffset               - Rows to Skip (>= 0 verified)
     * @param pLimit                - Max Rows to return (>= 1 verified)
     *
     * @return !Null
     */
    public String buildQuery( String pProductVersion, String pTableName, //
                              String pSelectColumns, String pSelectionWhereClause, String pOrderBy, //
                              long pOffset, int pLimit );

    public boolean validateConnection( Connection pConnection, DBinfo pDBinfo )
            throws SQLException;

    public String normalizeIdentifier( String pIdentifier );

    public String[] getTablesFor( Connection pConnection, DBinfo pDBinfo, String pTableNamePattern )
            throws SQLException;

    public Map<String, DBtableColumn[]> getColumns( Connection pConnection, DBinfo pDBinfo, String pTableNamePattern )
            throws SQLException;

    public Map<String, DBtableIndex[]> getIndexes( Connection pConnection, DBinfo pDBinfo, String pTableName )
            throws SQLException;

    public boolean tableExists( Connection pConnection, DBinfo pDBinfo, String pTableName )
            throws SQLException, MultipleTablesException;

    public boolean columnExists( Connection pConnection, DBinfo pDBinfo, String pTableName, String pColumnName )
            throws SQLException, MultipleTablesException;

    public WrappedSQLException wrapSQLException( SQLException pException );
}