Application: gvSIG desktop

package org.gvsig.fmap.dal;

import java.util.List;

import org.cresques.cts.IProjection;

import org.gvsig.expressionevaluator.ExpressionBuilder;

import org.gvsig.expressionevaluator.ExpressionBuilder.Parameter;

import org.gvsig.expressionevaluator.ExpressionBuilder.Value;

import org.gvsig.expressionevaluator.ExpressionBuilder.Variable;

import org.gvsig.expressionevaluator.ExpressionBuilder.Visitable;

import org.gvsig.expressionevaluator.Formatter;

import org.gvsig.expressionevaluator.GeometryExpressionBuilder;

import org.gvsig.expressionevaluator.GeometryExpressionBuilderHelper.GeometrySupportType;

import org.gvsig.fmap.dal.feature.FeatureAttributeDescriptor;

import org.gvsig.fmap.dal.feature.FeatureType;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.tools.util.Bitmask;

import org.gvsig.tools.util.IsEmpty;

public interface SQLBuilder extends Visitable {

    public static final String PROP_FEATURE_TYPE = "FeatureType";

    public static final String PROP_TABLE = "Table";

    public static final String PROP_TABLENAME = "TableName";

    public static final String PROP_SYMBOLTABLE = "SymbolTable";

    public static final String PROP_JDBCHELPER = "JDBCHelper";

    public static final String PROP_QUERY = "Query";

    public static final String PROP_SQLBUILDER = "SQLBUILDER";

    public static final String PROP_ADD_TABLE_NAME_TO_COLUMNS = "ADD_TABLE_NAME";

    public static final String FEATURE_ATTRIBUTE_DESCRIPTOR = "FeatureAttributeDescriptor";

    public static final int DEFAULT_RECOMENDED_SQL_LENGTH = 2048;

    public enum Privilege {

        SELECT,

        INSERT,

        UPDATE,

        DELETE,

        TRUNCATE,

        REFERENCE,

        TRIGGER,

        ALL

    };

    public interface ColumnDescriptor {

        public String getName();

        public int getType();

        public int getSize();

        public int getPrecision();

        public int getScale();

        public boolean isPrimaryKey();

        public boolean isIndexed();

        public boolean isAutomatic();

        boolean allowNulls();

        boolean allowIndexDuplicateds();

        public Object getDefaultValue();

        public int getGeometryType();

        public int getGeometrySubtype();

        public Object getGeometrySRSId();

        public boolean isGeometry();

        public DataStoreParameters getStoreParameters();

        public void setName(String name);

        public void setType(int type);

        public void setSize(int size);

        public void setPrecision(int precision);

        public void setScale(int scale);

        public void setIsPrimaryKey(boolean isPk);

        public void setIsAutomatic(boolean isAutomatic);

        public void setAllowNulls(boolean allowNulls);

        public void setAllowIndexDuplicateds(boolean allowIndexDuplicateds);

        public void setDefaultValue(Object defaultValue);

        public void setGeometryType(int geom_type);

        public void setGeometrySubtype(int geom_subtype);

        public void setGeometrySRSId(Object geom_srsid);

        public Envelope getTableBBox();

        public void setTableBBox(Envelope bbox);

    }

    public interface StatementPart extends Value {

    }

    public interface Statement extends StatementPart {

    }

    public interface Column extends Variable {

        public TableNameBuilder table();

        public TableNameBuilder table(TableNameBuilder table);

    }

    public interface TableNameBuilder extends StatementPart, IsEmpty {

        public TableNameBuilder database(String name);

        public TableNameBuilder schema(String name);

        public TableNameBuilder name(String name);

        public String getDatabase();

        public String getSchema();

        public String getName();

        public boolean has_database();

        public boolean has_schema();

        public boolean has_name();

    }

    public interface CountBuilder extends StatementPart {

        public CountBuilder all();

        public CountBuilder column(Value value);

        public CountBuilder distinct();

    }

    public interface SelectColumnBuilder extends StatementPart {

        public SelectColumnBuilder name(String name);

        public SelectColumnBuilder name(TableNameBuilder table, String name);

        public SelectColumnBuilder table(TableNameBuilder table);

        public SelectColumnBuilder value(Value value);

        public SelectColumnBuilder as(String alias);

        public SelectColumnBuilder as_geometry();

        public SelectColumnBuilder all();

        public String getName();

        public String getAlias();

        public Value getValue();

        public boolean isGeometry();

        public TableNameBuilder getTable();

        public boolean isAggregateFunction();

    }

    public interface InsertColumnBuilder extends StatementPart {

        public InsertColumnBuilder name(String name);

        public InsertColumnBuilder with_value(Value value);

        public String getName();

        public Value getValue();

    }

    public interface UpdateColumnBuilder extends InsertColumnBuilder {

        @Override

        public UpdateColumnBuilder name(String name);

        @Override

        public UpdateColumnBuilder with_value(Value value);

        @Override

        public String getName();

        @Override

        public Value getValue();

    }

    public interface FromBuilder extends StatementPart {

        public TableNameBuilder table();

        public FromBuilder subquery(String subquery);

        public FromBuilder custom(String passthrough);

        public FromBuilder left_join(TableNameBuilder table, Value expression);

        public List<JoinBuilder> getJoins();

    }

    public interface JoinBuilder extends StatementPart {

        ExpressionBuilder.Value getCondition();

        SQLBuilder.TableNameBuilder getTable();

        String getType();

    }

    public interface OrderByBuilder extends StatementPart {

        public static int MODE_NULLS_FIRST = 0;

        public static int MODE_NULLS_LAST = 1;

        public static int MODE_NULLS_NOT_SPECIFIED = 2;

        public OrderByBuilder column(String name);

        public boolean isColumn(String name);

        public boolean isColumn(Value value);

//        @Deprecated

//        public OrderByBuilder column(Value name);

        public OrderByBuilder value(Value expression);

        public OrderByBuilder ascending(boolean asc);

        public OrderByBuilder ascending();

        public OrderByBuilder descending();

        public OrderByBuilder nulls(int mode);

        public OrderByBuilder custom(String order);

        public int getNullsMode();

    }

    public interface SelectBuilder extends Statement {

        public SelectColumnBuilder column();

        public SelectColumnBuilder column(String name);

        public SelectColumnBuilder column(SelectColumnBuilder column);

        public SelectBuilder remove_all_columns();

        public FromBuilder from();

        public GeometryExpressionBuilder where();

        public OrderByBuilder order_by();

        public OrderByBuilder getOrderBy(String column);

        public OrderByBuilder getOrderBy(Value column);

        public SelectBuilder group_by(Value... column);

        public SelectBuilder distinct();

        public SelectBuilder limit(long limit);

        public SelectBuilder limit(Long limit);

        /**

         * Specifies an offset to be applied to the SQL statement. Only an

         * offset can be applied if an order has been specified. Otherwise an

         * IllegalStateException exception will be thrown when constructing the

         * SQL statement invoking the toString method.

         *

         * @param offset

         * @return this SelectBuilder

         */

        public SelectBuilder offset(long offset);

        public boolean has_column(String name);

        public boolean has_where();

        public boolean has_from();

        public boolean has_order_by();

        public boolean has_group_by();

        public boolean has_aggregate_functions();

        public boolean has_limit();

        public boolean has_offset();

        public void disable_check_order_and_offset();

        /**

         * Constructs the SQL statement. If the values associated with the SQL

         * statement are not valid an IllegalStateException exception is thrown.

         *

         * @return the SQL select statement.

         * @throws IllegalStateException if the values of select statement are

         * not valids.

         */

        @Override

        public String toString();

        public List<Value> getGroups();

        public List<SelectColumnBuilder> getColumns();

        public SelectColumnBuilder getColumn(String name);

        public void remove_column(String columnName);

        public boolean isGroupBy(String name);

    }

    public interface UpdateBuilder extends Statement {

        public TableNameBuilder table();

        public UpdateColumnBuilder column();

        public GeometryExpressionBuilder where();

        public boolean has_where();

    }

    public interface InsertBuilder extends Statement {

        public TableNameBuilder table();

        public InsertColumnBuilder column();

    }

    public interface DeleteBuilder extends Statement {

        public TableNameBuilder table();

        public GeometryExpressionBuilder where();

        public boolean has_where();

    }

    public interface AlterTableBuilder extends Statement {

        public static final int ALTER_COLUMN_ALL = 1;

        public static final int ALTER_COLUMN_GEOMETRY = 2;

        public static final int ALTER_COLUMN_SET_DEFAULT = 3;

        public static final int ALTER_COLUMN_SET_NULL = 4;

        public static final int ALTER_COLUMN_SET_DATA_TYPE = 5;

        public static final int ALTER_COLUMN_ADD_PRIMARY_KEY = 6;

        public static final int ALTER_COLUMN_DROP_PRIMARY_KEY = 7;

        public static final int ALTER_COLUMN_CREATE_INDEX = 8;

        public static final int ALTER_COLUMN_DROP_INDEX = 9;

        public static final int ALTER_COLUMN_DROP_COLUMN = 10;

        public static final int ALTER_COLUMN_ADD_COLUMN = 11;

        public TableNameBuilder table();

        public AlterTableBuilder drop_column(String columnName);

        public AlterTableBuilder drop_primary_key(String columnName);

        public AlterTableBuilder add_column(FeatureAttributeDescriptor fad);

        public AlterTableBuilder add_column(String columnName, int type, int size, int precision, int scale, boolean isPk, boolean isIndexed, boolean allowNulls, boolean isAutomatic, Object defaultValue, boolean allowIndexDuplicateds);

        public AlterTableBuilder add_geometry_column(String columnName, int geom_type, int geom_subtype, IProjection proj, boolean isIndexed, boolean allowNulls);

        public AlterTableBuilder add_geometry_column(String columnName, int geom_type, int geom_subtype, Object srsdbcode, boolean isIndexed, boolean allowNulls);

        public AlterTableBuilder alter_column(Bitmask operation, FeatureAttributeDescriptor fad);

        public AlterTableBuilder alter_column(Bitmask operation, String columnName, int type, int size, int precision, int scale, boolean isPk, boolean isIndexed, boolean allowNulls, boolean isAutomatic, Object defaultValue, boolean allowIndexDuplicateds);

        public AlterTableBuilder alter_geometry_column(Bitmask operation,String columnName, int geom_type, int geom_subtype, IProjection proj, boolean isIndexed, boolean allowNulls);

        public AlterTableBuilder alter_geometry_column(Bitmask operation, String columnName, int geom_type, int geom_subtype, Object srsdbcode, boolean isIndexed, boolean allowNulls);

        public AlterTableBuilder rename_column(String source, String target);

        public boolean isEmpty();

        public List<String> toStrings();

        public List<String> toStrings(Formatter formatter);

    }

    public interface CreateTableBuilder extends Statement {

        public TableNameBuilder table();

        public CreateTableBuilder add_column(FeatureAttributeDescriptor fad);

        public CreateTableBuilder add_column(String columnName, int type, int size, int precision, int scale, boolean isPk, boolean isIndexed, boolean allowNulls, boolean isAutomatic, Object defaultValue);

        public CreateTableBuilder add_geometry_column(String columnName, int geom_type, int geom_subtype, IProjection proj, boolean isIndexed, boolean allowNulls);

        public CreateTableBuilder add_geometry_column(String columnName, int geom_type, int geom_subtype, Object srsdbcode, boolean isIndexed, boolean allowNulls);

        public ColumnDescriptor getColumnDescriptor(String columnName);

        public List<String> toStrings();

        public List<String> toStrings(Formatter formatter);

    }

    public interface UpdateTableStatisticsBuilder extends Statement {

        public TableNameBuilder table();

        public List<String> toStrings();

        public List<String> toStrings(Formatter formatter);

    }

    public interface GrantRoleBuilder extends StatementPart {

        public GrantRoleBuilder privilege(Privilege privilege);

        public GrantRoleBuilder select();

        public GrantRoleBuilder insert();

        public GrantRoleBuilder delete();

        public GrantRoleBuilder truncate();

        public GrantRoleBuilder reference();

        public GrantRoleBuilder update();

        public GrantRoleBuilder trigger();

        public GrantRoleBuilder all();

    }

    public interface GrantBuilder extends Statement {

        public TableNameBuilder table();

        public GrantRoleBuilder role(String name);

        public List<String> toStrings();

        public List<String> toStrings(Formatter formatter);

    }

    public interface DropTableBuilder extends Statement {

        public TableNameBuilder table();

        public List<String> toStrings();

        public List<String> toStrings(Formatter formatter);

    }

    public interface CreateIndexBuilder extends Statement {

        public CreateIndexBuilder if_not_exist();

        public CreateIndexBuilder unique();

        public CreateIndexBuilder name(String name);

        public CreateIndexBuilder name(String tableName, String columnName);

        public CreateIndexBuilder spatial();

        public CreateIndexBuilder column(String name);

        public TableNameBuilder table();

        public List<String> toStrings();

        public List<String> toStrings(Formatter formatter);

        public void setFeatureType(FeatureType type);

    }

    public interface DropIndexBuilder extends Statement {

        public DropIndexBuilder if_exist();

        public DropIndexBuilder name(String name);

        public DropIndexBuilder name(String tableName, String columnName);

        public List<String> toStrings();

        public List<String> toStrings(Formatter formatter);

    }

    public String default_schema();

    public boolean support_schemas();

    public boolean has_spatial_functions();

    public GeometrySupportType geometry_support_type();

    public String sqltype(int dataType, int size, int precision, int scale, int geomType, int geomSubtype);

    public Object sqlgeometrytype(int type, int subtype);

    public Object sqlgeometrydimension(int type, int subtype);

    public Object srs_id(IProjection projection);

    public String toString(Formatter formatter);

    public List<Variable> variables();

    public List<String> variables_names();

    public List<Parameter> parameters();

    public List<String> parameters_names();

    public TableNameBuilder table_name();

    public TableNameBuilder createTableNameBuilder();

    public SelectColumnBuilder column();

    public SelectBuilder select();

    public UpdateBuilder update();

    public InsertBuilder insert();

    public DeleteBuilder delete();

    public AlterTableBuilder alter_table();

    public CreateTableBuilder create_table();

    public CreateIndexBuilder create_index();

    public DropIndexBuilder drop_index();

    public GrantBuilder grant();

    public DropTableBuilder drop_table();

    public UpdateTableStatisticsBuilder update_table_statistics();

    public CountBuilder count();

    public GeometryExpressionBuilder expression();

    public String as_identifier(String id);

    public String as_clob(String s);

    public String as_string(String s);

    public String as_string(byte[] s);

    public String as_string(boolean value);

    public String as_string(Number value);

    public String as_string(Object value);

    public Column column(String name);

    public Column column(TableNameBuilder table, String name);

    public Column column_from(Variable variable);

    public Column column_from(TableNameBuilder table, Variable variable);    

    public void setProperties(Class classToApply, Object... values);

    public void setProperties(ExpressionBuilder.Visitable visitable, Class filter, final Object... values);

    public Formatter formatter();

    public boolean isAggregateFunction(String funcname);

    public int getMaxRecomendedSQLLength();

    public SelectBuilder createSelectBuilder();

    public String getConstrainName(TableNameBuilder table, String columnName, String constrainType);

}