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 Stringaliasprotected static FieldHandlerIFDEFAULT_FIELD_HANDLERprotected static ClassDEFAULT_VALUE_TYPEprotected FieldHandlerIFfhandlerprotected SQLTable[]tablesprotected Objectvalueprotected Classvtype
-
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 StringgetAlias()INTERNAL: The column alias to use if this value is included in the projection.intgetArity()INTERNAL: Returns the [column] arity of the value.FieldHandlerIFgetFieldHandler()INTERNAL: Returns the field handler for the columns.SQLValueIFgetReference()INTERNAL: Returns the referenced value if one exists.SQLTable[]getTables()INTERNAL: Returns the tables that are involved in the verbatim expression.intgetType()INTERNAL: Returns the value class type.ObjectgetValue()intgetValueArity()INTERNAL: Returns the value arity of the value.ClassgetValueType()INTERNAL: Returns the value type.booleanisReference()INTERNAL: Returns true if this value is a reference to another.voidsetAlias(String alias)INTERNAL: Sets the column alias.voidsetFieldHandler(FieldHandlerIF fhandler)INTERNAL: Sets the field handler for the value.voidsetTables(SQLTable[] tables)voidsetValueType(Class vtype)INTERNAL: Sets the value type.StringtoString()
-
-
-
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:SQLValueIFINTERNAL: Returns the value class type. The type is represented by one of the constants in theSQLValueIFinterface.- Specified by:
getTypein interfaceSQLValueIF
-
getArity
public int getArity()
Description copied from interface:SQLValueIFINTERNAL: Returns the [column] arity of the value. The number represents the number of "columns" the value spans, i.e. its composite width.- Specified by:
getArityin interfaceSQLValueIF
-
getValueArity
public int getValueArity()
Description copied from interface:SQLValueIFINTERNAL: 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:
getValueArityin interfaceSQLValueIF
-
getAlias
public String getAlias()
Description copied from interface:SQLValueIFINTERNAL: 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:
getAliasin interfaceSQLValueIF
-
setAlias
public void setAlias(String alias)
Description copied from interface:SQLValueIFINTERNAL: Sets the column alias.- Specified by:
setAliasin interfaceSQLValueIF
-
isReference
public boolean isReference()
Description copied from interface:SQLValueIFINTERNAL: Returns true if this value is a reference to another.- Specified by:
isReferencein interfaceSQLValueIF
-
getReference
public SQLValueIF getReference()
Description copied from interface:SQLValueIFINTERNAL: Returns the referenced value if one exists.- Specified by:
getReferencein interfaceSQLValueIF
-
getValue
public Object getValue()
-
getValueType
public Class getValueType()
Description copied from interface:SQLValueIFINTERNAL: Returns the value type.- Specified by:
getValueTypein interfaceSQLValueIF
-
setValueType
public void setValueType(Class vtype)
Description copied from interface:SQLValueIFINTERNAL: Sets the value type.- Specified by:
setValueTypein 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:
getFieldHandlerin interfaceSQLValueIF
-
setFieldHandler
public void setFieldHandler(FieldHandlerIF fhandler)
Description copied from interface:SQLValueIFINTERNAL: Sets the field handler for the value.- Specified by:
setFieldHandlerin 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)
-
-