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

org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter Class Reference

List of all members.

Public Member Functions

 DatabaseProcedureParameter (String name, int columnType, int nullable)
 DatabaseProcedureParameter (String name, int columnType, int dataType, String typeName, float precision, int length, int scale, int radix, int nullable, String remarks)
final int getColumnType ()
final void setColumnType (int columnType)
final int getDataType ()
final void setDataType (int dataType)
final int getLength ()
final void setLength (int length)
final String getName ()
final void setName (String name)
final int getNullable ()
final void setNullable (int nullable)
final float getPrecision ()
final void setPrecision (int precision)
final int getRadix ()
final void setRadix (int radix)
final String getRemarks ()
final void setRemarks (String remarks)
final int getScale ()
final void setScale (int scale)
final String getTypeName ()
final void setTypeName (String typeName)
boolean equals (Object other)
String getXml ()

Static Public Member Functions

int getNullFromString (String nullable)
String getNullFromInt (int nullable)
String getColumnTypeFromInt (int type)
int getColumnTypeFromString (String type)

Static Public Attributes

final int ProcedureColumnUnknown = 0
final int ProcedureColumnIn = 1
final int ProcedureColumnInOut = 2
final int ProcedureColumnOut = 3
final int ProcedureColumnReturn = 4
final int ProcedureColumnResult = 5
final int ProcedureNoNulls = 0
final int ProcedureNullable = 1
final int ProcedureNullableUnknown = 2

Detailed Description

Represents a parameter of procedure

Author:
Nicolas Modrzyk

Definition at line 37 of file DatabaseProcedureParameter.java.


Constructor & Destructor Documentation

org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.DatabaseProcedureParameter String  name,
int  columnType,
int  nullable
 

Reduced version of constructor for static schemas

Parameters:
name column/parameter name
columnType kind of column/parameter
nullable can it contain NULL?

Definition at line 164 of file DatabaseProcedureParameter.java.

00165   {
00166     this(name, columnType, Types.VARCHAR, "VARCHAR", 0, 0, 0, 0, nullable, "");
00167   }

org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.DatabaseProcedureParameter String  name,
int  columnType,
int  dataType,
String  typeName,
float  precision,
int  length,
int  scale,
int  radix,
int  nullable,
String  remarks
 

Parameters:
name column/parameter name
columnType kind of column/parameter
dataType SQL type from java.sql.Types
typeName SQL type name, for a UDT type the type name is fully qualified
precision precision
length length in bytes of data
scale scale
radix radix
nullable can it contain NULL?
remarks comment describing parameter/column

Definition at line 182 of file DatabaseProcedureParameter.java.

00185   {
00186     this.name = name;
00187     this.columnType = columnType;
00188     this.dataType = dataType;
00189     this.typeName = typeName;
00190     this.precision = precision;
00191     this.length = length;
00192     this.scale = scale;
00193     this.radix = radix;
00194     this.nullable = nullable;
00195     this.remarks = remarks;
00196   }


Member Function Documentation

boolean org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.equals Object  other  ) 
 

Two DatabaseProcedureParameter are considered equal if they have the same name and the same descriptive attributes.

Parameters:
other the object to compare with
Returns:
true if the DatabaseProcedureParameter are equal

Definition at line 365 of file DatabaseProcedureParameter.java.

References org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.columnType, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.dataType, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.length, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.name, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.nullable, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.precision, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.radix, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.remarks, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.scale, and org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.typeName.

00366   {
00367     if ((other == null) || !(other instanceof DatabaseProcedureParameter))
00368       return false;
00369 
00370     DatabaseProcedureParameter p = (DatabaseProcedureParameter) other;
00371 
00372     // first we check simple types
00373     if (!(p.columnType == columnType && p.dataType == dataType
00374         && p.precision == precision && p.length == length && p.scale == scale
00375         && p.radix == radix && p.nullable == nullable))
00376     {
00377       return false;
00378     }
00379 
00380     // now we compare object types
00381     if (!(name == null ? p.name == null : name.equals(p.name)))
00382     {
00383       return false;
00384     }
00385 
00386     if (!(typeName == null ? p.typeName == null : typeName.equals(p.typeName)))
00387     {
00388       return false;
00389     }
00390 
00391     return remarks == null ? p.remarks == null : remarks.equals(p.remarks);
00392   }

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getColumnType  ) 
 

Returns:
Returns the columnType.

Definition at line 201 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseDynamicMetaData.getProcedureColumns().

00202   {
00203     return columnType;
00204   }

String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getColumnTypeFromInt int  type  )  [static]
 

get column type given an int

Parameters:
type as an int from the java specification
Returns:
a description as a string

Definition at line 115 of file DatabaseProcedureParameter.java.

References org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnIn, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnInOut, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnOut, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnResult, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnReturn, and org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnUnknown.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getXml().

00116   {
00117     switch (type)
00118     {
00119       case ProcedureColumnIn :
00120         return DatabasesXmlTags.VAL_in;
00121       case ProcedureColumnOut :
00122         return DatabasesXmlTags.VAL_out;
00123       case ProcedureColumnInOut :
00124         return DatabasesXmlTags.VAL_inout;
00125       case ProcedureColumnReturn :
00126         return DatabasesXmlTags.VAL_return;
00127       case ProcedureColumnResult :
00128         return DatabasesXmlTags.VAL_result;
00129       case ProcedureColumnUnknown :
00130       default :
00131         return DatabasesXmlTags.VAL_unknown;
00132     }
00133   }

int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getColumnTypeFromString String  type  )  [static]
 

get type from string

Parameters:
type of the parameter
Returns:
value given the java specification

Definition at line 141 of file DatabaseProcedureParameter.java.

00142   {
00143     if (type.equalsIgnoreCase(DatabasesXmlTags.VAL_in))
00144       return ProcedureColumnIn;
00145     if (type.equalsIgnoreCase(DatabasesXmlTags.VAL_out))
00146       return ProcedureColumnOut;
00147     if (type.equalsIgnoreCase(DatabasesXmlTags.VAL_inout))
00148       return ProcedureColumnInOut;
00149     if (type.equalsIgnoreCase(DatabasesXmlTags.VAL_return))
00150       return ProcedureColumnReturn;
00151     if (type.equalsIgnoreCase(DatabasesXmlTags.VAL_result))
00152       return ProcedureColumnResult;
00153     else
00154       return ProcedureColumnUnknown;
00155   }

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getDataType  ) 
 

Returns:
Returns the dataType.

Definition at line 217 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseDynamicMetaData.getProcedureColumns().

00218   {
00219     return dataType;
00220   }

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getLength  ) 
 

Returns:
Returns the length.

Definition at line 233 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseDynamicMetaData.getProcedureColumns().

00234   {
00235     return length;
00236   }

final String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getName  ) 
 

Returns:
Returns the name.

Definition at line 249 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseDynamicMetaData.getProcedureColumns().

00250   {
00251     return name;
00252   }

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getNullable  ) 
 

Returns:
Returns the nullable.

Definition at line 265 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseDynamicMetaData.getProcedureColumns().

00266   {
00267     return nullable;
00268   }

String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getNullFromInt int  nullable  )  [static]
 

get null ability given an int

Parameters:
nullable as an integer
Returns:
a string conformed to dtd

Definition at line 95 of file DatabaseProcedureParameter.java.

References org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureNoNulls, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureNullable, and org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureNullableUnknown.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getXml().

00096   {
00097     switch (nullable)
00098     {
00099       case ProcedureNoNulls :
00100         return DatabasesXmlTags.VAL_noNulls;
00101       case ProcedureNullable :
00102         return DatabasesXmlTags.VAL_nullable;
00103       case ProcedureNullableUnknown :
00104       default :
00105         return DatabasesXmlTags.VAL_nullableUnknown;
00106     }
00107   }

int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getNullFromString String  nullable  )  [static]
 

get null ability given a string

Parameters:
nullable recognized are "nonulls" and "nullable"
Returns:
value given the java specification

Definition at line 79 of file DatabaseProcedureParameter.java.

00080   {
00081     if (nullable.equalsIgnoreCase(DatabasesXmlTags.VAL_noNulls))
00082       return ProcedureNoNulls;
00083     if (nullable.equalsIgnoreCase(DatabasesXmlTags.VAL_nullable))
00084       return ProcedureNullable;
00085     else
00086       return ProcedureNullableUnknown;
00087   }

final float org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getPrecision  ) 
 

Returns:
Returns the precision.

Definition at line 281 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseDynamicMetaData.getProcedureColumns().

00282   {
00283     return precision;
00284   }

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getRadix  ) 
 

Returns:
Returns the radix.

Definition at line 297 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseDynamicMetaData.getProcedureColumns().

00298   {
00299     return radix;
00300   }

final String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getRemarks  ) 
 

Returns:
Returns the remarks.

Definition at line 313 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseDynamicMetaData.getProcedureColumns().

00314   {
00315     return remarks;
00316   }

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getScale  ) 
 

Returns:
Returns the scale.

Definition at line 329 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseDynamicMetaData.getProcedureColumns().

00330   {
00331     return scale;
00332   }

final String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getTypeName  ) 
 

Returns:
Returns the typeName.

Definition at line 345 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseDynamicMetaData.getProcedureColumns().

00346   {
00347     return typeName;
00348   }

String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getXml  ) 
 

Get xml information about this procedure.

Returns:
xml formatted information on this database procedure.

Definition at line 399 of file DatabaseProcedureParameter.java.

References org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getColumnTypeFromInt(), and org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getNullFromInt().

00400   {
00401     StringBuffer info = new StringBuffer();
00402     info.append("<" + DatabasesXmlTags.ELT_DatabaseProcedureColumn + " "
00403         + DatabasesXmlTags.ATT_name + "=\"" + name + "\"" + " "
00404         + DatabasesXmlTags.ATT_paramType + "=\""
00405         + getColumnTypeFromInt(columnType) + "\"" + " "
00406         + DatabasesXmlTags.ATT_nullable + "=\"" + getNullFromInt(nullable)
00407         + "\"/>");
00408     return info.toString();
00409   }

final void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.setColumnType int  columnType  ) 
 

Parameters:
columnType The columnType to set.

Definition at line 209 of file DatabaseProcedureParameter.java.

00210   {
00211     this.columnType = columnType;
00212   }

final void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.setDataType int  dataType  ) 
 

Parameters:
dataType The dataType to set.

Definition at line 225 of file DatabaseProcedureParameter.java.

00226   {
00227     this.dataType = dataType;
00228   }

final void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.setLength int  length  ) 
 

Parameters:
length The length to set.

Definition at line 241 of file DatabaseProcedureParameter.java.

00242   {
00243     this.length = length;
00244   }

final void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.setName String  name  ) 
 

Parameters:
name The name to set.

Definition at line 257 of file DatabaseProcedureParameter.java.

00258   {
00259     this.name = name;
00260   }

final void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.setNullable int  nullable  ) 
 

Parameters:
nullable The nullable to set.

Definition at line 273 of file DatabaseProcedureParameter.java.

00274   {
00275     this.nullable = nullable;
00276   }

final void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.setPrecision int  precision  ) 
 

Parameters:
precision The precision to set.

Definition at line 289 of file DatabaseProcedureParameter.java.

00290   {
00291     this.precision = precision;
00292   }

final void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.setRadix int  radix  ) 
 

Parameters:
radix The radix to set.

Definition at line 305 of file DatabaseProcedureParameter.java.

00306   {
00307     this.radix = radix;
00308   }

final void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.setRemarks String  remarks  ) 
 

Parameters:
remarks The remarks to set.

Definition at line 321 of file DatabaseProcedureParameter.java.

00322   {
00323     this.remarks = remarks;
00324   }

final void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.setScale int  scale  ) 
 

Parameters:
scale The scale to set.

Definition at line 337 of file DatabaseProcedureParameter.java.

00338   {
00339     this.scale = scale;
00340   }

final void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.setTypeName String  typeName  ) 
 

Parameters:
typeName The typeName to set.

Definition at line 353 of file DatabaseProcedureParameter.java.

00354   {
00355     this.typeName = typeName;
00356   }


Member Data Documentation

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnIn = 1 [static]
 

IN parameter

Definition at line 44 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getColumnTypeFromInt().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnInOut = 2 [static]
 

INOUT parameter

Definition at line 46 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getColumnTypeFromInt().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnOut = 3 [static]
 

OUT parameter

Definition at line 48 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getColumnTypeFromInt().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnResult = 5 [static]
 

procedure return value

Definition at line 52 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getColumnTypeFromInt().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnReturn = 4 [static]
 

procedure return value

Definition at line 50 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getColumnTypeFromInt().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureColumnUnknown = 0 [static]
 

nobody knows

Definition at line 42 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getColumnTypeFromInt().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureNoNulls = 0 [static]
 

does not allow NULL values

Definition at line 56 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getNullFromInt().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureNullable = 1 [static]
 

allows NULL values

Definition at line 58 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getNullFromInt().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.ProcedureNullableUnknown = 2 [static]
 

nullability unknown

Definition at line 60 of file DatabaseProcedureParameter.java.

Referenced by org.objectweb.cjdbc.common.sql.schema.DatabaseProcedureParameter.getNullFromInt().


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