public interface ISQLFieldInfo
An object that contains metadata for either a column in a result set or a parameter in an SQL statement.
Method | Description |
String getAlias() | Returns the alias of the table that is associated with the column. |
int getIndex() | Returns the index value of the column, as it occurs in the result set. |
String getName() | Returns the name of either the column in the result set or the parameter in the SQL statement. |
String getSchema() | Returns the schema name for the column. |
String getTable() | Returns the table name for the column. |
int getType() | Returns a code value that represents the SQL type of the column, as defined
in java.sql.Types . |
boolean isExpression() | Indicates whether the column in the result set is derived from an expression. |
boolean isKey() | Indicates whether the column is a key. |
public String getAlias()Returns the alias of the table that is associated with the column.
Return value is undefined if the column is derived from an expression.
- Returns
- the name of the table's alias, if it exists; otherwise, null.
public int getIndex()Returns the index value of the column, as it occurs in the result set.
- Returns
- the column's index value.
public String getName()Returns the name of either the column in the result set or the parameter in the SQL statement.
If the column in the result set is derived from an expression, this method returns the expression.
- Returns
- the column or parameter name or expression.
public String getSchema()Returns the schema name for the column.
Return value is undefined if the column is derived from an expression.
- Returns
- the schema name.
public String getTable()Returns the table name for the column.
Return value is undefined if the column is derived from an expression.
- Returns
- the table name.
public int getType()Returns a code value that represents the SQL type of the column, as defined in
java.sql.Types
. The corresponding Java type of the column can be obtained from theIBeanData.getJavaTypeforSql()
method.Return value is undefined if the column is derived from an expression.
- Returns
- the code that represents the SQL type.
- See Also
public boolean isExpression()Indicates whether the column in the result set is derived from an expression.
If the column is derived from an expression, the following occurs:
- The method
getName()
returns the expression.- The return values for
getTable()
,getSchema()
,getAlias()
, andgetType()
are undefined.
- Returns
true
if the column is derived from an expression; otherwise,false
.
public boolean isKey()Indicates whether the column is a key.
- Returns
true
if the column is a key; otherwise,false
.