ModSQL
Class Operator_Negate

java.lang.Object
  |
  +--ModSQL.AbstractFunction
        |
        +--ModSQL.Operator
              |
              +--ModSQL.Operator_Negate

All Implemented Interfaces:

Function

final class Operator_Negate

extends Operator

SQL operator "-".

Author:

chris.studholme@utoronto.ca

Fields inherited from class ModSQL.AbstractFunction

all_constant, constant_non_null, evaluate_order, evaluate_order_array, out_of_order, parameter_constant, parameter_value, parameters, parameters_array

Fields inherited from interface ModSQL.Function

MATCH_BEGINS, MATCH_EQU, MATCH_GT, MATCH_GTE, MATCH_LT, MATCH_LTE, MATCH_NE

Constructor Summary

Operator_Negate()
Default constructor.

Operator_Negate(Function parameter)
Constructor with parameter.

Method Summary

Object	evaluate(boolean aggregate) Evaluate parameter and negate.
Object	evaluate(int match_op, Object match_value) Evaluate parameter and negate.
String	functionName() Returns "#NEGATE".
int	getMaxResultSize() Returns -1 as this operator will never return a String object.
int	getSQLType() Returns the type of the parameter.
void	optimize() Prepare the function for use.

Methods inherited from class ModSQL.Operator

addAllParameters, addAllParametersNegate, addAllParametersNot, removeDoubleNegation, removeDoubleNot

Methods inherited from class ModSQL.AbstractFunction

addParameter, convertToSQLType, evaluateConstantParameters, evaluateOrder, evaluateParameters, evaluateParameters, getCompatableType, getObjectSQLType, getParameter, getParameterCount, isAggregate, isConstant, postfixParameters, prefixParameters, registerWith, reset, toString

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait

Constructor Detail

Operator_Negate

public Operator_Negate()

Default constructor.

Operator_Negate

public Operator_Negate(Function parameter)
                throws SQLException

Constructor with parameter.

Parameters:

parameter - first (and only) parameter

Throws:

SQLException - if there is an error with the parameter

Method Detail

optimize

public void optimize()
              throws SQLException

Prepare the function for use.

Overrides:

optimize in class AbstractFunction

Throws:

SQLException - if the parameter is invalid

functionName

public String functionName()

Returns "#NEGATE".

Overrides:

functionName in class AbstractFunction

Returns:

name of function

getSQLType

public int getSQLType()
               throws SQLException

Returns the type of the parameter.

Returns:

SQL type of data to be returned

Throws:

SQLException - if a database-access error occurs.

getMaxResultSize

public int getMaxResultSize()

Returns -1 as this operator will never return a String object.

Returns:

maximum size of String returned or -1 if unknown

evaluate

public Object evaluate(boolean aggregate)
                throws SQLException,
                       EndOfTable

Evaluate parameter and negate.

Parameters:

aggregate - passed to parameter

Returns:

result object

Throws:

SQLException - if a database-access error occurs

EndOfTable - if thrown by a parameter

evaluate

public Object evaluate(int match_op,
                       Object match_value)
                throws SQLException,
                       EndOfTable

Evaluate parameter and negate.

Overrides:

evaluate in class AbstractFunction

Parameters:

match_op - how the value should be matched

match_value - desired value

Returns:

result object

Throws:

SQLException - if a database-access error occurs

EndOfTable - if thrown by a parameter