org.objectweb.cjdbc.common.sql.schema
Class DatabaseProcedure

java.lang.Object
  org.objectweb.cjdbc.common.sql.schema.DatabaseProcedure

public class DatabaseProcedure

extends java.lang.Object

Represents a procedure

Author:

Nicolas Modrzyk

Field Summary

private java.lang.String	name
(package private) java.util.ArrayList	parameters
static int	ProcedureNoResult Does not return a result
static int	ProcedureResultUnknown May return a result
static int	ProcedureReturnsResult Returns a result
private int	procedureType
private java.lang.String	remarks

Constructor Summary

DatabaseProcedure(java.lang.String name, java.lang.String remarks, int procedureType)

Method Summary

void	addParameter(DatabaseProcedureParameter param) Add a parameter to this procedure
boolean	equals(java.lang.Object other) Two DatabaseProcedure are considered equal if they have the same name and the same parameters.
java.lang.String	getName()
java.util.ArrayList	getParameters()
int	getProcedureType()
java.lang.String	getRemarks()
static java.lang.String	getTypeFromInt(int type) Convert type from integer to string
static int	getTypeFromString(java.lang.String type) Convert type from string to integer
java.lang.String	getXml() Get xml information about this procedure.
void	mergeParameters(DatabaseProcedure procedure) Merges this procedure parameters with the given procedure's parameters.
void	setName(java.lang.String name)
void	setParameters(java.util.ArrayList parameters)
void	setProcedureType(int procedureType)
void	setRemarks(java.lang.String remarks)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ProcedureResultUnknown

public static final int ProcedureResultUnknown

May return a result

See Also:

Constant Field Values

ProcedureNoResult

public static final int ProcedureNoResult

Does not return a result

See Also:

Constant Field Values

ProcedureReturnsResult

public static final int ProcedureReturnsResult

Returns a result

See Also:

Constant Field Values

parameters

java.util.ArrayList parameters

name

private java.lang.String name

remarks

private java.lang.String remarks

procedureType

private int procedureType

Constructor Detail

DatabaseProcedure

public DatabaseProcedure(java.lang.String name,
                         java.lang.String remarks,
                         int procedureType)

Parameters:

name - of the procedure

remarks - of the procedure

procedureType - see above types

Method Detail

getTypeFromString

public static int getTypeFromString(java.lang.String type)

Convert type from string to integer

Parameters:

type - as a string

Returns:

ProcedureNoResult or ProcedureReturnsResult or ProcedureResultUnknown if not found

getTypeFromInt

public static java.lang.String getTypeFromInt(int type)

Convert type from integer to string

Parameters:

type - as an int

Returns:

string value conforms to xml tags.

addParameter

public void addParameter(DatabaseProcedureParameter param)

Add a parameter to this procedure

Parameters:

param - to add

getName

public java.lang.String getName()

Returns:

Returns the name.

setName

public void setName(java.lang.String name)

Parameters:

name - The name to set.

getParameters

public java.util.ArrayList getParameters()

Returns:

Returns the parameters.

setParameters

public void setParameters(java.util.ArrayList parameters)

Parameters:

parameters - The parameters to set.

getProcedureType

public int getProcedureType()

Returns:

Returns the procedureType.

setProcedureType

public void setProcedureType(int procedureType)

Parameters:

procedureType - The procedureType to set.

getRemarks

public java.lang.String getRemarks()

Returns:

Returns the remarks.

setRemarks

public void setRemarks(java.lang.String remarks)

Parameters:

remarks - The remarks to set.

mergeParameters

public void mergeParameters(DatabaseProcedure procedure)
                     throws java.sql.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.

Parameters:

procedure - the procedure to merge

Throws:

java.sql.SQLException - if the schemas conflict

equals

public boolean equals(java.lang.Object other)

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

Parameters:

other - the object to compare with

Returns:

true if the DatabaseProcedures are equal

getXml

public java.lang.String getXml()

Get xml information about this procedure.

Returns:

xml formatted information on this database procedure.