メインページ | パッケージ | クラス階層 | 構成 | ファイル一覧 | 構成メンバ | 関連ページ | 検索 

クラス org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure

すべてのメンバ一覧

説明

Represents a procedure

作者:
Nicolas Modrzyk

DatabaseProcedure.java の 38 行で定義されています。

Public メソッド

 DatabaseProcedure (String name, String remarks, int procedureType)
void addParameter (DatabaseProcedureParameter param)
String getName ()
void setName (String name)
ArrayList getParameters ()
void setParameters (ArrayList parameters)
int getProcedureType ()
void setProcedureType (int procedureType)
String getRemarks ()
void setRemarks (String remarks)
void mergeParameters (DatabaseProcedure procedure) throws SQLException
boolean equals (Object other)
String getXml ()

Static Public メソッド

int getTypeFromString (String type)
String getTypeFromInt (int type)

Static Public 変数

final int ProcedureResultUnknown = 0
final int ProcedureNoResult = 1
final int ProcedureReturnsResult = 2

変数

ArrayList parameters

Private 変数

String name
String remarks
int procedureType

コンストラクタとデストラクタ

org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.DatabaseProcedure (  String  name,
String  remarks,
int  procedureType
) 
 

引数:
name of the procedure
remarks of the procedure
procedureType see above types
DatabaseProcedure.java の 93 行で定義されています。
00094   {
00095     this.name = name;
00096     this.remarks = remarks;
00097     this.procedureType = procedureType;
00098     this.parameters = new ArrayList();
00099   }

メソッド

void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.addParameter (  DatabaseProcedureParameter  param  ) 
 

Add a parameter to this procedure

引数:
param to add
DatabaseProcedure.java の 106 行で定義されています。

参照先 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.parameters.

参照元 org.objectweb.cjdbc.controller.backend.DatabaseBackendMetaData.getProcedures().

00107   {
00108     parameters.add(param);
00109   }

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

Two DatabaseProcedure are considered equal if they have the same name and the same parameters.

引数:
other the object to compare with
戻り値:
true if the DatabaseProcedures are equal
DatabaseProcedure.java の 211 行で定義されています。

参照先 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getName(), org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getParameters(), org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.name, と org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.parameters.

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseSchema.isCompatibleSubset(), と org.objectweb.cjdbc.common.sql.schema.DatabaseSchema.isCompatibleWith().

00212   {
00213     if ((other == null) || !(other instanceof DatabaseProcedure))
00214       return false;
00215 
00216     DatabaseProcedure p = (DatabaseProcedure) other;
00217     return (p.getName().equals(name)) && (p.getParameters().equals(parameters));
00218   }

String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getName (   ) 
 

戻り値:
Returns the name.
DatabaseProcedure.java の 114 行で定義されています。

参照先 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.name.

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.equals(), org.objectweb.cjdbc.common.sql.schema.DatabaseSchema.getProcedure(), org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseMetaData.getProcedureColumns(), org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseMetaData.getProcedures(), org.objectweb.cjdbc.controller.backend.DatabaseBackendMetaData.getProcedures(), org.objectweb.cjdbc.common.sql.schema.DatabaseSchema.hasProcedure(), org.objectweb.cjdbc.common.sql.schema.DatabaseSchema.isCompatibleSubset(), org.objectweb.cjdbc.common.sql.schema.DatabaseSchema.isCompatibleWith(), org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.mergeParameters(), と org.objectweb.cjdbc.common.sql.schema.DatabaseSchema.mergeSchema().

00115   {
00116     return name;
00117   }

ArrayList org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getParameters (   ) 
 

戻り値:
Returns the parameters.
DatabaseProcedure.java の 130 行で定義されています。

参照先 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.parameters.

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.equals(), と org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseMetaData.getProcedureColumns().

00131   {
00132     return parameters;
00133   }

int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getProcedureType (   ) 
 

戻り値:
Returns the procedureType.
DatabaseProcedure.java の 146 行で定義されています。

参照先 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.procedureType.

参照元 org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseMetaData.getProcedures().

00147   {
00148     return procedureType;
00149   }

String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getRemarks (   ) 
 

戻り値:
Returns the remarks.
DatabaseProcedure.java の 162 行で定義されています。

参照先 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.remarks.

参照元 org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabaseMetaData.getProcedures().

00163   {
00164     return remarks;
00165   }

String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getTypeFromInt (  int  type  )  [static]
 

Convert type from integer to string

引数:
type as an int
戻り値:
string value conforms to xml tags.
DatabaseProcedure.java の 75 行で定義されています。

参照先 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.ProcedureNoResult, と org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.ProcedureReturnsResult.

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getXml().

00076   {
00077     switch (type)
00078     {
00079       case ProcedureNoResult :
00080         return DatabasesXmlTags.VAL_noResult;
00081       case ProcedureReturnsResult :
00082         return DatabasesXmlTags.VAL_returnsResult;
00083       default :
00084         return DatabasesXmlTags.VAL_resultUnknown;
00085     }
00086   }

int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getTypeFromString (  String  type  )  [static]
 

Convert type from string to integer

引数:
type as a string
戻り値:
ProcedureNoResult or ProcedureReturnsResult or ProcedureResultUnknown if not found
DatabaseProcedure.java の 59 行で定義されています。

参照先 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.ProcedureNoResult, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.ProcedureResultUnknown, と org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.ProcedureReturnsResult.

00060   {
00061     if (type.equals(DatabasesXmlTags.VAL_noResult))
00062       return ProcedureNoResult;
00063     if (type.equals(DatabasesXmlTags.VAL_returnsResult))
00064       return ProcedureReturnsResult;
00065     else
00066       return ProcedureResultUnknown;
00067   }

String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getXml (   ) 
 

Get xml information about this procedure.

戻り値:
xml formatted information on this database procedure.
DatabaseProcedure.java の 225 行で定義されています。

参照先 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getTypeFromInt(), org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.name, org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.parameters, と org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.procedureType.

00226   {
00227     StringBuffer info = new StringBuffer();
00228     info.append("<" + DatabasesXmlTags.ELT_DatabaseProcedure + " "
00229         + DatabasesXmlTags.ATT_name + "=\"" + name + "\" "
00230         + DatabasesXmlTags.ATT_returnType + "=\""
00231         + getTypeFromInt(procedureType) + "\">");
00232     for (int i = 0; i < parameters.size(); i++)
00233       info.append(((DatabaseProcedureParameter) parameters.get(i)).getXml());
00234     info.append("</" + DatabasesXmlTags.ELT_DatabaseProcedure + ">");
00235     return info.toString();
00236   }

void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.mergeParameters (  DatabaseProcedure  procedure  )  throws SQLException
 

Merges this procedure parameters with the given procedure's parameters. An exception is thrown if the given procedure parameters conflict with this one. If any parameter is different the exception is thrown.

引数:
procedure the procedure to merge
例外:
SQLException if the schemas conflict
DatabaseProcedure.java の 183 行で定義されています。

参照先 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getName(), と org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.parameters.

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseSchema.mergeSchema().

00184   {
00185     if (procedure == null)
00186       return;
00187 
00188     ArrayList otherParameters = procedure.getParameters();
00189     if (otherParameters == null && parameters == null)
00190       return;
00191 
00192     if (this.equals(procedure))
00193     {
00194       // Procedures are the same, no conflict
00195       return;
00196     }
00197     else
00198     {
00199       throw new SQLException("Unable to merge procedure " + getName()
00200           + ": parameters are differents ");
00201     }
00202   }

void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.setName (  String  name  ) 
 

引数:
name The name to set.
DatabaseProcedure.java の 122 行で定義されています。
00123   {
00124     this.name = name;
00125   }

void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.setParameters (  ArrayList  parameters  ) 
 

引数:
parameters The parameters to set.
DatabaseProcedure.java の 138 行で定義されています。
00139   {
00140     this.parameters = parameters;
00141   }

void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.setProcedureType (  int  procedureType  ) 
 

引数:
procedureType The procedureType to set.
DatabaseProcedure.java の 154 行で定義されています。
00155   {
00156     this.procedureType = procedureType;
00157   }

void org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.setRemarks (  String  remarks  ) 
 

引数:
remarks The remarks to set.
DatabaseProcedure.java の 170 行で定義されています。
00171   {
00172     this.remarks = remarks;
00173   }

変数

String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.name [private]
 

DatabaseProcedure.java の 48 行で定義されています。

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.equals(), org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getName(), と org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getXml().

ArrayList org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.parameters [package]
 

DatabaseProcedure.java の 47 行で定義されています。

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.addParameter(), org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.equals(), org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getParameters(), org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getXml(), と org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.mergeParameters().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.ProcedureNoResult = 1 [static]
 

Does not return a result DatabaseProcedure.java の 43 行で定義されています。

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getTypeFromInt(), と org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getTypeFromString().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.ProcedureResultUnknown = 0 [static]
 

May return a result DatabaseProcedure.java の 41 行で定義されています。

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getTypeFromString().

final int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.ProcedureReturnsResult = 2 [static]
 

Returns a result DatabaseProcedure.java の 45 行で定義されています。

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getTypeFromInt(), と org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getTypeFromString().

int org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.procedureType [private]
 

DatabaseProcedure.java の 50 行で定義されています。

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getProcedureType(), と org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getXml().

String org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.remarks [private]
 

DatabaseProcedure.java の 49 行で定義されています。

参照元 org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure.getRemarks().

このクラスの説明は次のファイルから生成されました:
CJDBCversion1.0.4に対してTue Oct 12 15:16:18 2004に生成されました。 doxygen 1.3.8