Interface SQLValueIF
-
- All Known Implementing Classes:
SQLColumns
,SQLFunction
,SQLNull
,SQLParameter
,SQLPrimitive
,SQLTuple
,SQLValueReference
,SQLVerbatim
public interface SQLValueIF
INTERNAL: Represents a SQL value.
-
-
Field Summary
Fields Modifier and Type Field Description static int
COLUMNS
INTERNAL: Constant referring to theSQLColumns
class.static int
FUNCTION
INTERNAL: Constant referring to theSQLFunction
class.static int
NULL
INTERNAL: Constant referring to theSQLNull
class.static int
PARAMETER
INTERNAL: Constant referring to theSQLParameter
class.static int
PRIMITIVE
INTERNAL: Constant referring to theSQLPrimitive
class.static int
TUPLE
INTERNAL: Constant referring to theSQLTuple
class.static int
VERBATIM
INTERNAL: Constant referring to theSQLVerbatim
class.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.Class
getValueType()
INTERNAL: Returns the value type.boolean
isReference()
INTERNAL: Returns true if this value is a reference to another.void
setAlias(String alias)
INTERNAL: Sets the column alias.void
setFieldHandler(FieldHandlerIF fhandler)
INTERNAL: Sets the field handler for the value.void
setValueType(Class vtype)
INTERNAL: Sets the value type.
-
-
-
Field Detail
-
NULL
static final int NULL
INTERNAL: Constant referring to theSQLNull
class.- See Also:
- Constant Field Values
-
TUPLE
static final int TUPLE
INTERNAL: Constant referring to theSQLTuple
class.- See Also:
- Constant Field Values
-
COLUMNS
static final int COLUMNS
INTERNAL: Constant referring to theSQLColumns
class.- See Also:
- Constant Field Values
-
PRIMITIVE
static final int PRIMITIVE
INTERNAL: Constant referring to theSQLPrimitive
class.- See Also:
- Constant Field Values
-
PARAMETER
static final int PARAMETER
INTERNAL: Constant referring to theSQLParameter
class.- See Also:
- Constant Field Values
-
VERBATIM
static final int VERBATIM
INTERNAL: Constant referring to theSQLVerbatim
class.- See Also:
- Constant Field Values
-
FUNCTION
static final int FUNCTION
INTERNAL: Constant referring to theSQLFunction
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 theSQLValueIF
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
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 asfrom foo".
-
setAlias
void setAlias(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
Class getValueType()
INTERNAL: Returns the value type.
-
setValueType
void setValueType(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.
-
-