Class SqlColumn

java.lang.Object

com.randomnoun.common.jexl.sql.SqlColumn

public class SqlColumn
extends Object

Objects of this type are used in the evaluation context passed into an SqlGenerator to define a database column used in a TopLevelExpression.

See the SqlGenerator class for detailed documentation.

Author:

knoxg

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ARRAY	These constants are copied directly from the java.sql.Types class; note that we also add the new types MONEYVALUE, DATEVALUE, TIMEVALUE, FIXEDDATEVALUE and FIXEDTIMEVALUE
static final int	BIGINT
static final int	BINARY
static final int	BIT
static final int	BLOB
static final int	BOOLEAN
static final int	CHAR
static final int	CLOB
static final int	DATALINK
static final int	DATE
static final int	DATEVALUE
static final int	DECIMAL
static final int	DISTINCT
static final int	DOUBLE
static final int	FIXEDDATEVALUE
static final int	FIXEDTIMEVALUE
static final int	FLOAT
static final int	INTEGER
static final int	JAVA_OBJECT
static final int	LONGVARBINARY
static final int	LONGVARCHAR
static final int	MONEYVALUE	The range 5000-6000 is currently unused in java.sql.Types; (and doesn't look like it will ever be used), so I'm going to use this for custom types.
static final int	NULL
static final int	NUMERIC
static final int	OTHER
static final int	REAL
static final int	REF
static final int	SMALLINT
static final int	STRUCT
static final int	TIME
static final int	TIMESTAMP
static final int	TIMEVALUE
static final int	TINYINT
static final int	VARBINARY
static final int	VARCHAR

Constructor Summary

Constructors

Constructor	Description
SqlColumn(String name)	Create a new column, of type VARCHAR
SqlColumn(String name, int dataType)	Create a new column, with the supplied datatype
SqlColumn(String name, String table)	Create a new column, in a specific table, of type VARCHAR
SqlColumn(String name, String table, int dataType)	Create a new column, in a specific table, with the supplied datatype

Method Summary

Modifier and Type	Method	Description
String	getCurrencyCodeName()	Retrieves the currency column of this SqlColumn, as supplied by setCurrencyCodeName
int	getDataType()	Retrieves the data type of this SqlColumn
String	getFullCurrencyCodeName()	Either returns the name of the currency column, or table + "." + currency name, if a table has been set
String	getFullName()	Either returns the name of this column, or table + "." + name, if a table has been set
String	getName()	Retrieves the name of this SqlColumn, as set by the constructor
String	getTable()	Retrieves the table of this SqlColumn, as set by the constructor
void	setCurrencyCodeName(String currencyCodeName)	Sets the column name that contains the currency code, for a MONEYVALUE SqlColumn.
String	toString()	Retrieve a string representation of this column

Methods inherited from class Object

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

Field Details

ARRAY

public static final int ARRAY

These constants are copied directly from the java.sql.Types class; note that we also add the new types MONEYVALUE, DATEVALUE, TIMEVALUE, FIXEDDATEVALUE and FIXEDTIMEVALUE

See Also:

• Constant Field Values

BIGINT

public static final int BIGINT

See Also:

• Constant Field Values

BINARY

public static final int BINARY

See Also:

• Constant Field Values

BIT

public static final int BIT

See Also:

• Constant Field Values

BLOB

public static final int BLOB

See Also:

• Constant Field Values

BOOLEAN

public static final int BOOLEAN

See Also:

• Constant Field Values

CHAR

public static final int CHAR

See Also:

• Constant Field Values

CLOB

public static final int CLOB

See Also:

• Constant Field Values

DATALINK

public static final int DATALINK

See Also:

• Constant Field Values

DATE

public static final int DATE

See Also:

• Constant Field Values

DECIMAL

public static final int DECIMAL

See Also:

• Constant Field Values

DISTINCT

public static final int DISTINCT

See Also:

• Constant Field Values

DOUBLE

public static final int DOUBLE

See Also:

• Constant Field Values

FLOAT

public static final int FLOAT

See Also:

• Constant Field Values

INTEGER

public static final int INTEGER

See Also:

• Constant Field Values

JAVA_OBJECT

public static final int JAVA_OBJECT

See Also:

• Constant Field Values

LONGVARBINARY

public static final int LONGVARBINARY

See Also:

• Constant Field Values

LONGVARCHAR

public static final int LONGVARCHAR

See Also:

• Constant Field Values

NULL

public static final int NULL

See Also:

• Constant Field Values

NUMERIC

public static final int NUMERIC

See Also:

• Constant Field Values

OTHER

public static final int OTHER

See Also:

• Constant Field Values

REAL

public static final int REAL

See Also:

• Constant Field Values

REF

public static final int REF

See Also:

• Constant Field Values

SMALLINT

public static final int SMALLINT

See Also:

• Constant Field Values

STRUCT

public static final int STRUCT

See Also:

• Constant Field Values

TIME

public static final int TIME

See Also:

• Constant Field Values

TIMESTAMP

public static final int TIMESTAMP

See Also:

• Constant Field Values

TINYINT

public static final int TINYINT

See Also:

• Constant Field Values

VARBINARY

public static final int VARBINARY

See Also:

• Constant Field Values

VARCHAR

public static final int VARCHAR

See Also:

• Constant Field Values

MONEYVALUE

public static final int MONEYVALUE

The range 5000-6000 is currently unused in java.sql.Types; (and doesn't look like it will ever be used), so I'm going to use this for custom types. Anything in here is treated specially in SqlGenerator when converting to SQL.

See Also:

• Constant Field Values

DATEVALUE

public static final int DATEVALUE

See Also:

• Constant Field Values

TIMEVALUE

public static final int TIMEVALUE

See Also:

• Constant Field Values

FIXEDDATEVALUE

public static final int FIXEDDATEVALUE

See Also:

• Constant Field Values

FIXEDTIMEVALUE

public static final int FIXEDTIMEVALUE

See Also:

• Constant Field Values

Constructor Details

SqlColumn

public SqlColumn(String name)

Create a new column, of type VARCHAR

Parameters:

name - The name of the column in the database

SqlColumn

public SqlColumn(String name,
 int dataType)

Create a new column, with the supplied datatype

Parameters:

name - The name of the column in the database

dataType - The datatype of the column. Corresponds to one of the public static final int constants defined in this class.

SqlColumn

public SqlColumn(String name,
 String table)

Create a new column, in a specific table, of type VARCHAR

Parameters:

name - The name of the column in the database

table - The name of the table in the database this column is in

SqlColumn

public SqlColumn(String name,
 String table,
 int dataType)

Create a new column, in a specific table, with the supplied datatype

Parameters:

name - The name of the column in the database

table - The name of the table in the database this column is in

dataType - The datatype of the column. Corresponds to one of the public static final int constants defined in this class.

Method Details

setCurrencyCodeName

public void setCurrencyCodeName(String currencyCodeName)

Sets the column name that contains the currency code, for a MONEYVALUE SqlColumn. If a table has been specified for this column, then the currency is always sourced from the same table.

Parameters:

currencyCodeName - the column name that contains the currency code

Throws:

IllegalStateException - if this method is called for a non-MONEYVALUE SqlColumn

getName

public String getName()

Retrieves the name of this SqlColumn, as set by the constructor

getTable

public String getTable()

Retrieves the table of this SqlColumn, as set by the constructor

getCurrencyCodeName

public String getCurrencyCodeName()

Retrieves the currency column of this SqlColumn, as supplied by setCurrencyCodeName

getDataType

public int getDataType()

Retrieves the data type of this SqlColumn

getFullName

public String getFullName()

Either returns the name of this column, or table + "." + name, if a table has been set

getFullCurrencyCodeName

public String getFullCurrencyCodeName()

Either returns the name of the currency column, or table + "." + currency name, if a table has been set

toString

public String toString()

Retrieve a string representation of this column

Overrides:

toString in class Object