Class SQLVerbatim
- java.lang.Object
-
- net.ontopia.persistence.query.sql.SQLVerbatim
-
- All Implemented Interfaces:
SQLValueIF
public class SQLVerbatim extends Object implements SQLValueIF
INTERNAL: Represents a verbatim SQL expression value.
-
-
Field Summary
Fields Modifier and Type Field Description protected String
alias
protected static FieldHandlerIF
DEFAULT_FIELD_HANDLER
protected static Class
DEFAULT_VALUE_TYPE
protected FieldHandlerIF
fhandler
protected SQLTable[]
tables
protected Object
value
protected Class
vtype
-
Constructor Summary
Constructors Constructor Description SQLVerbatim(Object value)
SQLVerbatim(Object value, SQLTable[] tables)
-
Method Summary
All Methods Instance Methods Concrete 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.SQLTable[]
getTables()
INTERNAL: Returns the tables that are involved in the verbatim expression.int
getType()
INTERNAL: Returns the value class type.Object
getValue()
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
setTables(SQLTable[] tables)
void
setValueType(Class vtype)
INTERNAL: Sets the value type.String
toString()
-
-
-
Field Detail
-
DEFAULT_VALUE_TYPE
protected static final Class DEFAULT_VALUE_TYPE
-
DEFAULT_FIELD_HANDLER
protected static final FieldHandlerIF DEFAULT_FIELD_HANDLER
-
value
protected Object value
-
alias
protected String alias
-
tables
protected SQLTable[] tables
-
vtype
protected Class vtype
-
fhandler
protected FieldHandlerIF fhandler
-
-
Method Detail
-
getType
public int getType()
Description copied from interface:SQLValueIF
INTERNAL: Returns the value class type. The type is represented by one of the constants in theSQLValueIF
interface.- Specified by:
getType
in interfaceSQLValueIF
-
getArity
public int getArity()
Description copied from interface:SQLValueIF
INTERNAL: Returns the [column] arity of the value. The number represents the number of "columns" the value spans, i.e. its composite width.- Specified by:
getArity
in interfaceSQLValueIF
-
getValueArity
public int getValueArity()
Description copied from interface:SQLValueIF
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.- Specified by:
getValueArity
in interfaceSQLValueIF
-
getAlias
public String getAlias()
Description copied from interface:SQLValueIF
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". - Specified by:
getAlias
in interfaceSQLValueIF
-
setAlias
public void setAlias(String alias)
Description copied from interface:SQLValueIF
INTERNAL: Sets the column alias.- Specified by:
setAlias
in interfaceSQLValueIF
-
isReference
public boolean isReference()
Description copied from interface:SQLValueIF
INTERNAL: Returns true if this value is a reference to another.- Specified by:
isReference
in interfaceSQLValueIF
-
getReference
public SQLValueIF getReference()
Description copied from interface:SQLValueIF
INTERNAL: Returns the referenced value if one exists.- Specified by:
getReference
in interfaceSQLValueIF
-
getValue
public Object getValue()
-
getValueType
public Class getValueType()
Description copied from interface:SQLValueIF
INTERNAL: Returns the value type.- Specified by:
getValueType
in interfaceSQLValueIF
-
setValueType
public void setValueType(Class vtype)
Description copied from interface:SQLValueIF
INTERNAL: Sets the value type.- Specified by:
setValueType
in interfaceSQLValueIF
-
getFieldHandler
public FieldHandlerIF getFieldHandler()
INTERNAL: Returns the field handler for the columns. Default field handler is DefaultFieldHandler with type java.sql.Types.VARCHAR when not specified.- Specified by:
getFieldHandler
in interfaceSQLValueIF
-
setFieldHandler
public void setFieldHandler(FieldHandlerIF fhandler)
Description copied from interface:SQLValueIF
INTERNAL: Sets the field handler for the value.- Specified by:
setFieldHandler
in interfaceSQLValueIF
-
getTables
public SQLTable[] getTables()
INTERNAL: Returns the tables that are involved in the verbatim expression. This information is neccessary so that the FROM clause can be correctly generated.
-
setTables
public void setTables(SQLTable[] tables)
-
-