Application: gvSIG desktop

package org.gvsig.expressionevaluator;

import java.awt.Color;

import java.util.Collections;

import java.util.Date;

import java.util.List;

import java.util.Map;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.tools.util.PropertiesSupport;

import org.gvsig.tools.util.PropertiesSupportHelper;

public interface ExpressionBuilder extends PropertiesSupport {

    public static boolean isFunction(Value value, String name) {

        return ( value instanceof Function &&

                StringUtils.equalsIgnoreCase(name, ((Function) value).name()));

    }    

    public static final String OPERATOR_NOT = "NOT";

    public static final String OPERATOR_NEGATE = "NEGATE";

    public static final String OPERATOR_IS = "IS";

    public static final String OPERATOR_IS_NULL = "IS NULL";

    public static final String OPERATOR_IS_NOT_NULL = "IS NOT NULL";

    public static final String OPERATOR_AND = "AND";

    public static final String OPERATOR_OR = "OR";

    public static final String OPERATOR_EQ = "=";

    public static final String OPERATOR_NE = "<>";

    public static final String OPERATOR_GT = ">";

    public static final String OPERATOR_GE = ">=";

    public static final String OPERATOR_LT = "<";

    public static final String OPERATOR_LE = "<=";

    public static final String OPERATOR_LIKE = "LIKE";

    public static final String OPERATOR_ILIKE = "ILIKE";

    public static final String OPERATOR_ADD = "+";

    public static final String OPERATOR_SUBST = "-";

    public static final String OPERATOR_MULT = "*";

    public static final String OPERATOR_DIV = "/";

    public static final String OPERATOR_MOD = "%";

    public static final String OPERATOR_CONCAT = "||";

    public static final String OPERATOR_REGEXP = "~";

    public static final String OPERATOR_AND2 = "&&";

    public static final String OPERATOR_IN = "IN";

    public static final String OPERATOR_BETWEEN = "BETWEEN";

    public static final String FUNCTION_CASE = "CASE";

    public static final String FUNCTION_IIF = "IIF";

    public static final String FUNCTION_IF = "IF";

    public static final String FUNCTION_IFNULL = "IFNULL";

    public static final String FUNCTION_LEFT = "LEFT";

    public static final String FUNCTION_RIGHT = "RIGHT";

    public static final String FUNCTION_LOCATE = "LOCATE";

    public static final String FUNCTION_POSITION = "POSITION";

    public static final String FUNCTION_LPAD = "LPAD";

    public static final String FUNCTION_RPAD = "RPAD";

    public static final String FUNCTION_LTRIM = "LTRIM";

    public static final String FUNCTION_RTRIM = "RTRIM";

    public static final String FUNCTION_TRIM = "TRIM";

    public static final String FUNCTION_REPEAT = "REPEAT";

    public static final String FUNCTION_REPLACE = "REPLACE";

    public static final String FUNCTION_ASCII = "ASCII";

    public static final String FUNCTION_LENGHT = "LENGHT";

    public static final String FUNCTION_INSTR = "INSTR";

    public static final String FUNCTION_LOWER = "LOWER";

    public static final String FUNCTION_UPPER = "UPPER";

    public static final String FUNCTION_SPACE = "SPACE";

    public static final String FUNCTION_SUBSTRING = "SUBSTRING";

    public static final String FUNCTION_CONCAT = "CONCAT";

    public static final String FUNCTION_ABS = "ABS";

    public static final String FUNCTION_ACOS = "ACOS";

    public static final String FUNCTION_ASIN = "ASIN";

    public static final String FUNCTION_ATAN = "ATAN";

    public static final String FUNCTION_COS = "COS";

    public static final String FUNCTION_COSH = "COSH";

    public static final String FUNCTION_COT = "COT";

    public static final String FUNCTION_BITAND = "BITAND";

    public static final String FUNCTION_BITOR = "BITOR";

    public static final String FUNCTION_BITXOR = "BITXOR";

    public static final String FUNCTION_CEIL = "CEIL";

    public static final String FUNCTION_DEGREES = "DEGREES";

    public static final String FUNCTION_EXP = "EXP";

    public static final String FUNCTION_FLOOR = "FLOOR";

    public static final String FUNCTION_LOG = "LOG";

    public static final String FUNCTION_LOG10 = "LOG10";

    public static final String FUNCTION_PI = "PI";

    public static final String FUNCTION_POWER = "POWER";

    public static final String FUNCTION_RADIANS = "RADIANS";

    public static final String FUNCTION_RAND = "RAND";

    public static final String FUNCTION_ROUND = "ROUND";

    public static final String FUNCTION_SQRT = "SQRT";

    public static final String FUNCTION_SIGN = "SIGN";

    public static final String FUNCTION_SIN = "SIN";

    public static final String FUNCTION_SINH = "SINH";

    public static final String FUNCTION_TAN = "TAN";

    public static final String FUNCTION_TANH = "TANH";

    public static final String FUNCTION_ZERO = "ZERO";

    public static final String FUNCTION_CHR = "CHR";

    public static final String FUNCTION_MOD = "MOD";

    public static final String FUNCTION_UUID = "UUID";

    public static final String FUNCTION_COUNT = "COUNT";

    public static final String FUNCTION_MAX = "MAX";

    public static final String FUNCTION_MIN = "MIN";

    public static final String FUNCTION_SUM = "SUM";

    public static final String FUNCTION_AVG = "AVG";

    public static final String FUNCTION_DATE = "DATE";

    public static final String FUNCTION_TIME = "TIME";

    public static final String FUNCTION_TIMESTAMP = "TIMESTAMP";  

    public static final String FUNCTION_TO_DATE = "TO_DATE";

    public static final String FUNCTION_TO_TIMESTAMP = "TO_TIMESTAMP";  

    public static final String FUNCTION_DATEDIFF = "DATEDIFF";

    public static final String FUNCTION_DATEADD = "DATEADD";

    public static final String FUNCTION_CURRENT_TIMESTAMP = "CURRENT_TIMESTAMP";

    public static final String FUNCTION_CURRENT_TIME = "CURRENT_TIME";

    public static final String FUNCTION_CURRENT_DATE = "CURRENT_DATE";

    public static final String FUNCTION_EXTRACT = "EXTRACT";

    public static final String FUNCTION_CAST = "CAST";

    public static final String FUNCTION_DECODE = "DECODE";

    public static final String FUNCTION_ENCODE = "ENCODE";

    public static final String FUNCTION_TODOUBLE = "TODOUBLE";

    public static final String FUNCTION_TOFLOAT = "TOFLOAT";

    public static final String FUNCTION_TOINTEGER = "TOINTEGER";

    public static final String FUNCTION_TOLONG = "TOLONG";

    public static final String FUNCTION_TOSTR = "TOSTR";

    public static final String FUNCTION_TOJSON = "TO_JSON";

    public static final String FUNCTION_MAP = "MAP";

    public static final String FUNCTION_LET = "LET";

    public static final String FUNCTION_INCR = "INCR";

    public static final String FUNCTION_DECR = "DECR";

    public static final String FUNCTION_RANGE = "RANGE";

    public static final String FUNCTION_EVAL = "EVAL";

    public static final String FUNCTION_LIST = "LIST";

    public static final String FUNCTION_TUPLE = "TUPLE";

    public static final String FUNCTION_DICT = "DICT";

    @Deprecated // Use HOST EXPRESSION

    public static final String FUNCTION_$CONSTANT = "$CONSTANT";

    @Deprecated // Use HOST EXPRESSION

    public static final String FUNCTION_$IDENTIFIER = "$IDENTIFIER";

    public static final String FUNCTION_$HOSTEXPRESSION = "$HOSTEXPRESSION";

    public static final String FUNCTION_GETATTR = "GETATTR";

    public static final String FUNCTION_SETATTR = "SETATTR";

    public static final String FUNCTION_GETITEM = "GETITEM";

    public static final String FUNCTION_URLREAD = "URL_READ";

    public static final String FUNCTION_URLREADBYTES = "URL_READBYTES";

    public static final String FUNCTION_URL = "URL";

    public static final String FUNCTION_CRC32 = "CRC";

    public static final String FUNCTION_MD5HEX = "MD5HEX";

    public static final String FUNCTION_COLOR = "COLOR";

    public static final String FUNCTION_JSON_VALUE = "JSON_VALUE";

    public static final int PARAMETER_TYPE_CONSTANT = 0;

    public static final int PARAMETER_TYPE_VARIABLE = 1;

    public interface VisitorFilter {

        boolean accept(Visitable visitable);

        default boolean skipChildren() { return false; }

    }

     public interface Visitor {

        public void visit(Visitable value);

    }

    public interface Visitable {

        public void accept(Visitor visitor, VisitorFilter filter);

    }

    public interface Value extends Visitable, PropertiesSupport, org.gvsig.tools.lang.Cloneable {

        public String toString(Formatter<Value> formatter);

        public void replace(Value target, Value replacement);

        public void copyPropertiesFrom(PropertiesSupport properties);

        @Override

        public Value clone() throws CloneNotSupportedException;

    }

    public interface Group extends Value {

        public Value value();

    }

    public interface Constant extends Value {

        public Object value();

    }

    public static final Constant VALUE_NULL = new Constant() {

        @Override

        public Object value() {

            return null;

        }

        @Override

        public String toString() {

            return "NULL";

        }

        @Override

        public String toString(Formatter<Value> formatter) {

            return "NULL";

        }

        @Override

        public void replace(Value target, Value replacement) {

        }

        @Override

        public void copyPropertiesFrom(PropertiesSupport properties) {

        }

        @Override

        @SuppressWarnings("CloneDoesntCallSuperClone")

        public Value clone() throws CloneNotSupportedException {

            return this;

        }

        @Override

        public void accept(Visitor visitor, VisitorFilter filter) {

        }

        @Override

        public Object getProperty(String name) {

            return null;

        }

        @Override

        public void setProperty(String name, Object value) {

        }

        @Override

        public Map<String, Object> getProperties() {

            return Collections.EMPTY_MAP;

        }

    };

    public interface Custom extends Value {

        public Object value();

        public Custom add(Variable variable);

        public Custom add(Parameter parameter);

    }

    public interface Variable extends Value, Comparable<Variable> {

        public String name();

    }

    public interface Parameter extends Value {

        public Parameter as_constant();

        public Parameter as_variable();        

        public Parameter value(Object value);

        public Parameter name(String value);

        public int type();

        public String name();

        public Object value();

        public boolean is_constant();

        public boolean is_variable();

    }

    public interface Function extends Value {

        public String name();

        public String name(String name);

        public List<Value> parameters();

        public Function parameter(Value parameter);

        public Function format(String format);

    }

    public interface Method extends Value {

        public String name();

        public Value instance();

        public List<Value> parameters();

        public Function parameter(Value parameter);

    }

    public interface BinaryOperator extends Function {

        public String name();

        public Value left();

        public Value right();

        public BinaryOperator left(Value operand);

        public BinaryOperator right(Value operand);

    }

    public abstract class AbstractValue implements Value {

        protected PropertiesSupportHelper properties;

        protected AbstractValue() {

            this.properties = new PropertiesSupportHelper();

        }

        @Override

        public Value clone() throws CloneNotSupportedException {

            AbstractValue other = (AbstractValue) super.clone();

            other.properties = properties.clone();

            return other;

        }

        @Override

        public void copyPropertiesFrom(PropertiesSupport properties) {

            for (Map.Entry<String, Object> entry : properties.getProperties().entrySet()) {

                String key = entry.getKey();

                Object value1 = entry.getValue();

                this.setProperty(key, value1);

            }

        }

        @Override

        public void accept(Visitor visitor, VisitorFilter filter) {

            if (filter == null || filter.accept(this)) {

                visitor.visit(this);

            }

        }

        @Override

        public Map<String, Object> getProperties() {

            return this.properties.getProperties();

        }

        @Override

        public Object getProperty(String name) {

            return this.properties.getProperty(name);

        }

        @Override

        public void setProperty(String name, Object value) {

            this.properties.setProperty(name, value);

        }

        @Override

        public void replace(Value target, Value replacement) {

            // Do nothing

        }

    }

    public class ClassVisitorFilter implements VisitorFilter {

        private final Class classFilter;

        public ClassVisitorFilter(Class classFilter) {

            this.classFilter = classFilter;

        }

        @Override

        public boolean accept(Visitable visitable) {

            if( classFilter==null ) {

                return true;

            }

            return classFilter.isInstance(visitable);

        }

    }

    public static final Formatter<Value> EMPTY_FORMATTER = new Formatter<Value>() {

        @Override

        public boolean canApply(Value value) {

            return false;

        }

        @Override

        public String format(Value value) {

            return "";

        }

    };

    public Formatter<Value> formatter();

    public String quote_for_identifiers();

    public String quote_for_strings();

    public void accept(Visitor visitor, VisitorFilter filter);

    public List<Variable> variables();

    public List<String> variables_names();

    public List<Parameter> parameters();

    public List<String> parameters_names();

    public String identifier(String name);

    public String bytearray_hex(byte[] data);

    public String bytearray_0x(byte[] data);

    public String bytearray_x(byte[] data);

    public String string(String s);

    public Value value();

    public ExpressionBuilder value(Value value);

    public Group group(Value group);

    public Constant bytearray(byte[] data);

    public Variable variable(String name);

    public Variable column(String name); // Alias for variable(name)

    public Value column(String tableName, String columnName);

    public Parameter parameter(String name);

    public Parameter parameter();

    public Constant constant(Object value);

    public Constant constant(Object value, int type);

    public Constant constant(Object value, Class theClass);

    public Custom custom(Object value);

    public Method method(Value instance, String name, Value... values);

    public Function function(String name, Value... values);

    public BinaryOperator binaryOperator(String name, Value leftOperand, Value rightOperand);

    public Value toValue(String expression);

    public String repr(Object value);

    public String toString(Formatter<Value> formatter);

    public Function not(Value value);

    public Function not_is_null(Value value);

    public Function is_null(Value value);

    public BinaryOperator and(Value op1, Value op2);

    public BinaryOperator and(Expression op1, Expression op2);

    public BinaryOperator and(Expression op1, Value op2);

    public BinaryOperator or(Value op1, Value op2);

    public BinaryOperator eq(Value op1, Value op2);

    public BinaryOperator ne(Value op1, Value op2);

    public BinaryOperator gt(Value op1, Value op2);

    public BinaryOperator ge(Value op1, Value op2);

    public BinaryOperator lt(Value op1, Value op2);

    public BinaryOperator le(Value op1, Value op2);

    public BinaryOperator like(Value op1, Value op2);

    public BinaryOperator ilike(Value op1, Value op2);

    public BinaryOperator add(Value op1, Value op2);

    public BinaryOperator subst(Value op1, Value op2);

    public BinaryOperator mult(Value op1, Value op2);

    public BinaryOperator div(Value op1, Value op2);

    public Function concat(Value...values);

    public ExpressionBuilder set(Value value);

    public ExpressionBuilder and(Value value);

    public ExpressionBuilder or(Value value);

    public Function iif(Value condition, Value iftrue, Value iffalse);

    public Function ifnull(Value value, Value iftrue, Value iffalse);

    public ExpressionBuilder createExpressionBuilder();

    public Function left(Value str, Value size);

    public Function right(Value str, Value len);

    public Function locate(Value search, Value str, Value start) ;

    public Function position(Value search, Value str);

    public Function lpad(Value str, Value len, Value padstr) ;

    public Function rpad(Value str, Value len, Value padstr);

    public Function ltrim(Value str);

    public Function rtrim(Value str);

    public Function trim(Value str);

    public Function repeat(Value str, Value size);

    public Function replace(Value str, Value search, Value replstr);

    public Function ascii(Value str);

    public Function lenght(Value str);

    public Function instr(Value str, Value search, Value start);

    public Function lower(Value str);

    public Function upper(Value str);

    public Function space(Value size);

    public Function substring(Value str, Value start, Value len);

    public Function abs(Value num);

    public Function acos(Value num);

    public Function asin(Value num);

    public Function atan(Value num);

    public Function cos(Value num);

    public Function cosh(Value num);

    public Function cot(Value num);

    public Function bitand(Value num1, Value num2);

    public Function bitor(Value num1, Value num2);

    public Function bitxor(Value num1, Value num2);

    public Function ceil(Value num);

    public Function degrees(Value num);

    public Function exp(Value num);

    public Function floor(Value num);

    public Function log(Value num);

    public Function log10(Value num);

    public Function pi();

    public Function power(Value num);

    public Function radians(Value num);

    public Function rand(Value num);

    public Function round(Value num);

    public Function sqrt(Value num);

    public Function sign(Value num);

    public Function sin(Value num);

    public Function sinh(Value num);

    public Function tan(Value num);

    public Function tanh(Value num);

    public Function zero();

    public Function chr(Value num);

    public Function decode(Value value, Value format);

    public Function cast(Value object, Value typeName);

    public Function toDouble(Value object);

    public Function toFloat(Value object);

    public Function toLong(Value object);

    public Function toInteger(Value object);

    public Function toStr(Value object);

    public Function list();

    public Function tuple();

    public Function tuple(Object... values);

    public Function getattr(String objectId, String attributeId);

    public boolean isEmpty();

    public Function color(Value red, Value green, Value blue, Value alfa);

    public Function color(Color color);

    public Function date(Value date);

    public Function time(Value date);

    public Function timestamp(Value date);

    public Function date(Date date);

    public Function time(Date time);

    public Function timestamp(Date timestamp);

    public Function date(String date);

    public Function time(String time);

    public Function timestamp(String timestamp);

    public Function to_date(Value date, Value format);

    public Function to_timestamp(Value timestamp, Value format);

    public Function current_date();

    public Function current_time();

    public Function current_timestamp();

    public Function let(String name, Value value);

    public Function date_add(Value datefield, Value valueToAdd, Value date);

    public Function date_diff(Value datefield, Value valueToSubst, Value date);

    public Function extract(Value datefield, Value source);

    public String build(Formatter<Value> formatter);

    public String build();

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

}