net.ontopia.persistence.query.sql
Interface SQLValueIF

All Known Implementing Classes:

SQLColumns, SQLFunction, SQLNull, SQLParameter, SQLPrimitive, SQLTuple, SQLValueReference, SQLVerbatim

public interface SQLValueIF

INTERNAL: Represents a SQL value.

Field Summary

static int	COLUMNS INTERNAL: Constant referring to the SQLColumns class.
static int	FUNCTION INTERNAL: Constant referring to the SQLFunction class.
static int	NULL INTERNAL: Constant referring to the SQLNull class.
static int	PARAMETER INTERNAL: Constant referring to the SQLParameter class.
static int	PRIMITIVE INTERNAL: Constant referring to the SQLPrimitive class.
static int	TUPLE INTERNAL: Constant referring to the SQLTuple class.
static int	VERBATIM INTERNAL: Constant referring to the SQLVerbatim class.

Method Summary

java.lang.String	getAlias() INTERNAL: The column alias to use if this value is included in the projection.
int	getArity() INTERNAL: Returns the [column] arity of the value.
FieldHandlerIF	getFieldHandler() INTERNAL: Returns the field handler for the columns.
SQLValueIF	getReference() INTERNAL: Returns the referenced value if one exists.
int	getType() INTERNAL: Returns the value class type.
int	getValueArity() INTERNAL: Returns the value arity of the value.
java.lang.Class	getValueType() INTERNAL: Returns the value type.
boolean	isReference() INTERNAL: Returns true if this value is a reference to another.
void	setAlias(java.lang.String alias) INTERNAL: Sets the column alias.
void	setFieldHandler(FieldHandlerIF fhandler) INTERNAL: Sets the field handler for the value.
void	setValueType(java.lang.Class vtype) INTERNAL: Sets the value type.

Field Detail

NULL

static final int NULL

INTERNAL: Constant referring to the SQLNull class.

See Also:

Constant Field Values

TUPLE

static final int TUPLE

INTERNAL: Constant referring to the SQLTuple class.

See Also:

Constant Field Values

COLUMNS

static final int COLUMNS

INTERNAL: Constant referring to the SQLColumns class.

See Also:

Constant Field Values

PRIMITIVE

static final int PRIMITIVE

INTERNAL: Constant referring to the SQLPrimitive class.

See Also:

Constant Field Values

PARAMETER

static final int PARAMETER

INTERNAL: Constant referring to the SQLParameter class.

See Also:

Constant Field Values

VERBATIM

static final int VERBATIM

INTERNAL: Constant referring to the SQLVerbatim class.

See Also:

Constant Field Values

FUNCTION

static final int FUNCTION

INTERNAL: Constant referring to the SQLFunction class.

See Also:

Constant Field Values

Method Detail

getType

int getType()

INTERNAL: Returns the value class type. The type is represented by one of the constants in the SQLValueIF interface.

getArity

int getArity()

INTERNAL: Returns the [column] arity of the value. The number represents the number of "columns" the value spans, i.e. its composite width.

getValueArity

int getValueArity()

INTERNAL: Returns the value arity of the value. This number refers to the number of nested values this value contains including itself. Most values therefore have a value arity of 1. Nested values may have an arity higher than 1. SQLTuple is currently the only nested value type.

getAlias

java.lang.String getAlias()

INTERNAL: The column alias to use if this value is included in the projection. The SQL select syntax is typically like "select value as from foo".

setAlias

void setAlias(java.lang.String alias)

INTERNAL: Sets the column alias.

isReference

boolean isReference()

INTERNAL: Returns true if this value is a reference to another.

getReference

SQLValueIF getReference()

INTERNAL: Returns the referenced value if one exists.

getValueType

java.lang.Class getValueType()

INTERNAL: Returns the value type.

setValueType

void setValueType(java.lang.Class vtype)

INTERNAL: Sets the value type.

getFieldHandler

FieldHandlerIF getFieldHandler()

INTERNAL: Returns the field handler for the columns.

setFieldHandler

void setFieldHandler(FieldHandlerIF fhandler)

INTERNAL: Sets the field handler for the value.