Main Page | Packages | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

org.objectweb.cjdbc.driver.Field Class Reference

List of all members.

Public Member Functions

 Field (String table, String name, int columnDisplaySize, int sqlType, String typeName, String columnClassName)
 Field (String table, String name, int columnDisplaySize, int sqlType, String typeName, String columnClassName, boolean isAutoIncrement, boolean isCaseSensitive, boolean isCurrency, int isNullable, boolean isReadOnly, boolean isWritable, boolean isDefinitelyWritable, boolean isSearchable, boolean isSigned, int precision, int scale)
String getTableName ()
String getFieldName ()
String getFullName ()
void setFieldName (String name)
String toString ()
int getSqlType ()
String getTypeName ()
String getColumnClassName ()
int getColumnDisplaySize ()
boolean isAutoIncrement ()
boolean isCaseSensitive ()
boolean isCurrency ()
boolean isDefinitelyWritable ()
int isNullable ()
boolean isReadOnly ()
boolean isWritable ()
boolean isSearchable ()
boolean isSigned ()
int getPrecision ()
int getScale ()

Detailed Description

Field is a class used to describe fields in a ResultSet.

The first version was inspired from the MM MySQL driver by Mark Matthews.

See also:
org.objectweb.cjdbc.driver.DriverResultSet

org.objectweb.cjdbc.controller.virtualdatabase.ControllerResultSet

Author:
Emmanuel Cecchet

Nicolas Modrzyk

Version:
1.0

Definition at line 41 of file Field.java.

Constructor & Destructor Documentation

org.objectweb.cjdbc.driver.Field.Field (  String  table,
String  name,
int  columnDisplaySize,
int  sqlType,
String  typeName,
String  columnClassName
) 
 

Create a new field with some default common values.

Parameters:
table the table name
name the field name
columnDisplaySize the column display size
sqlType the SQL type
typeName the type name
columnClassName the column class name

Definition at line 71 of file Field.java.

00073   {
00074     this(table, name, columnDisplaySize, sqlType, typeName, columnClassName,
00075         false, true, false, ResultSetMetaData.columnNullable, true, false,
00076         false, false, false, 0, 0);
00077   }

org.objectweb.cjdbc.driver.Field.Field (  String  table,
String  name,
int  columnDisplaySize,
int  sqlType,
String  typeName,
String  columnClassName,
boolean  isAutoIncrement,
boolean  isCaseSensitive,
boolean  isCurrency,
int  isNullable,
boolean  isReadOnly,
boolean  isWritable,
boolean  isDefinitelyWritable,
boolean  isSearchable,
boolean  isSigned,
int  precision,
int  scale
) 
 

Creates a new Field instance.

Parameters:
table the table name
name the field name
columnDisplaySize the column display size
sqlType the SQL type
typeName the type name
columnClassName the column class name
isAutoIncrement true if field is auto incremented
isCaseSensitive true if field is case sensitive
isCurrency true if field is currency
isNullable indicates the nullability of the field
isReadOnly true if field is read only
isWritable true if field is writable
isDefinitelyWritable true if field is definetly writable
isSearchable true if field is searchable
isSigned true if field is signed
precision decimal precision
scale number of digits to right of decimal point

Definition at line 100 of file Field.java.

00105   {
00106     if (table == null)
00107       tableName = null;
00108     else
00109       tableName = new String(table);
00110     fieldName = new String(name);
00111     this.columnDisplaySize = columnDisplaySize;
00112     this.sqlType = sqlType;
00113     this.typeName = typeName;
00114     this.columnClassName = columnClassName;
00115     this.isAutoIncrement = isAutoIncrement;
00116     this.isCaseSensitive = isCaseSensitive;
00117     this.isCurrency = isCurrency;
00118     this.isNullable = isNullable;
00119     this.isReadOnly = isReadOnly;
00120     this.isWritable = isWritable;
00121     this.isDefinitelyWritable = isDefinitelyWritable;
00122     this.isSearchable = isSearchable;
00123     this.isSigned = isSigned;
00124     this.precision = precision;
00125     this.scale = scale;
00126   }

Member Function Documentation

String org.objectweb.cjdbc.driver.Field.getColumnClassName (   ) 
 

See also:
java.sql.ResultSetMetaData#getColumnClassName(int)

Definition at line 205 of file Field.java.

Referenced by org.objectweb.cjdbc.driver.ResultSetMetaData.getColumnClassName().

00206   {
00207     return columnClassName;
00208   }

int org.objectweb.cjdbc.driver.Field.getColumnDisplaySize (   ) 
 

See also:
java.sql.ResultSetMetaData#getColumnDisplaySize(int)

Definition at line 213 of file Field.java.

Referenced by org.objectweb.cjdbc.driver.ResultSetMetaData.getColumnDisplaySize().

00214   {
00215     return columnDisplaySize;
00216   }

String org.objectweb.cjdbc.driver.Field.getFieldName (   ) 
 

Gets the field name.

Returns:
a String value
See also:
setFieldName

Definition at line 144 of file Field.java.

Referenced by org.objectweb.cjdbc.driver.DriverResultSet.findColumn(), org.objectweb.cjdbc.driver.ResultSetMetaData.getColumnLabel(), and org.objectweb.cjdbc.driver.ResultSetMetaData.getColumnName().

00145   {
00146     return fieldName;
00147   }

String org.objectweb.cjdbc.driver.Field.getFullName (   ) 
 

Gets the full name: "tableName.fieldName"

Returns:
a String value

Definition at line 154 of file Field.java.

Referenced by org.objectweb.cjdbc.driver.DriverResultSet.findColumn(), org.objectweb.cjdbc.driver.ResultSetMetaData.getSchemaName(), and org.objectweb.cjdbc.driver.Field.toString().

00155   {
00156     return tableName + "." + fieldName;
00157   }

int org.objectweb.cjdbc.driver.Field.getPrecision (   ) 
 

See also:
java.sql.ResultSetMetaData#getPrecision(int)

Definition at line 293 of file Field.java.

Referenced by org.objectweb.cjdbc.driver.ResultSetMetaData.getPrecision().

00294   {
00295     return precision;
00296   }

int org.objectweb.cjdbc.driver.Field.getScale (   ) 
 

See also:
java.sql.ResultSetMetaData#getScale(int)

Definition at line 301 of file Field.java.

Referenced by org.objectweb.cjdbc.driver.ResultSetMetaData.getScale().

00302   {
00303     return scale;
00304   }

int org.objectweb.cjdbc.driver.Field.getSqlType (   ) 
 

Returns the SQL type.

Returns:
int Type according to java.sql.Types
See also:
java.sql.Types

Definition at line 187 of file Field.java.

Referenced by org.objectweb.cjdbc.driver.ResultSetMetaData.getColumnType().

00188   {
00189     return sqlType;
00190   }

String org.objectweb.cjdbc.driver.Field.getTableName (   ) 
 

Gets the table name.

Returns:
a String value

Definition at line 133 of file Field.java.

Referenced by org.objectweb.cjdbc.driver.ResultSetMetaData.getTableName().

00134   {
00135     return tableName;
00136   }

String org.objectweb.cjdbc.driver.Field.getTypeName (   ) 
 

Returns the SQL type name.

Returns:
the SQL type name

Definition at line 197 of file Field.java.

Referenced by org.objectweb.cjdbc.driver.ResultSetMetaData.getColumnTypeName().

00198   {
00199     return typeName;
00200   }

boolean org.objectweb.cjdbc.driver.Field.isAutoIncrement (   ) 
 

See also:
java.sql.ResultSetMetaData#isAutoIncrement(int)

Definition at line 221 of file Field.java.

00222   {
00223     return isAutoIncrement;
00224   }

boolean org.objectweb.cjdbc.driver.Field.isCaseSensitive (   ) 
 

See also:
java.sql.ResultSetMetaData#isCaseSensitive(int)

Definition at line 229 of file Field.java.

00230   {
00231     return isCaseSensitive;
00232   }

boolean org.objectweb.cjdbc.driver.Field.isCurrency (   ) 
 

See also:
java.sql.ResultSetMetaData#isCurrency(int)

Definition at line 237 of file Field.java.

00238   {
00239     return isCurrency;
00240   }

boolean org.objectweb.cjdbc.driver.Field.isDefinitelyWritable (   ) 
 

See also:
java.sql.ResultSetMetaData#isDefinitelyWritable(int)

Definition at line 245 of file Field.java.

00246   {
00247     return isDefinitelyWritable;
00248   }

int org.objectweb.cjdbc.driver.Field.isNullable (   ) 
 

See also:
java.sql.ResultSetMetaData#isNullable(int)

Definition at line 253 of file Field.java.

00254   {
00255     return isNullable;
00256   }

boolean org.objectweb.cjdbc.driver.Field.isReadOnly (   ) 
 

See also:
java.sql.ResultSetMetaData#isReadOnly(int)

Definition at line 261 of file Field.java.

00262   {
00263     return isReadOnly;
00264   }

boolean org.objectweb.cjdbc.driver.Field.isSearchable (   ) 
 

See also:
java.sql.ResultSetMetaData#isSearchable(int)

Definition at line 277 of file Field.java.

00278   {
00279     return isSearchable;
00280   }

boolean org.objectweb.cjdbc.driver.Field.isSigned (   ) 
 

See also:
java.sql.ResultSetMetaData#isSigned(int)

Definition at line 285 of file Field.java.

00286   {
00287     return isSigned;
00288   }

boolean org.objectweb.cjdbc.driver.Field.isWritable (   ) 
 

See also:
java.sql.ResultSetMetaData#isWritable(int)

Definition at line 269 of file Field.java.

00270   {
00271     return isWritable;
00272   }

void org.objectweb.cjdbc.driver.Field.setFieldName (  String  name  ) 
 

Sets the field name.

Parameters:
name the new field name
See also:
getFieldName

Definition at line 165 of file Field.java.

00166   {
00167     fieldName = name;
00168   }

String org.objectweb.cjdbc.driver.Field.toString (   ) 
 

Returns the full name.

Returns:
String value
See also:
getFullName()

Definition at line 176 of file Field.java.

References org.objectweb.cjdbc.driver.Field.getFullName().

Referenced by org.objectweb.cjdbc.driver.DriverResultSet.getByte().

00177   {
00178     return getFullName();
00179   }

The documentation for this class was generated from the following file:
Generated on Mon Apr 11 22:05:01 2005 for C-JDBC by  doxygen 1.3.9.1