com.metamatrix.query.sql.lang
Class StoredProcedure

java.lang.Object
  com.metamatrix.query.sql.lang.Command
      com.metamatrix.query.sql.lang.ProcedureContainer
          com.metamatrix.query.sql.lang.StoredProcedure

All Implemented Interfaces:

CommandContainer, LanguageObject, java.io.Serializable, java.lang.Cloneable

public class StoredProcedure
extends ProcedureContainer

Represents a StoredProcedure statement of the form:

See Also:

Serialized Form

Field Summary

Fields inherited from class com.metamatrix.query.sql.lang.Command

tempGroupIDs, TYPE_BATCHED_UPDATE, TYPE_CREATE, TYPE_DELETE, TYPE_DROP, TYPE_DYNAMIC, TYPE_INSERT, TYPE_QUERY, TYPE_SQL, TYPE_STORED_PROCEDURE, TYPE_UNKNOWN, TYPE_UPDATE, TYPE_UPDATE_PROCEDURE, TYPE_XQUERY

Constructor Summary

StoredProcedure()
Constructs a default instance of this class.

Method Summary

void	acceptVisitor(LanguageVisitor visitor) Method for accepting a visitor.
boolean	areResultsCachable() Whether the results are cachable.
void	clearParameters()
java.lang.Object	clone() Implement clone to make objects cloneable.
boolean	displayNamedParameters() Indicates whether parameters should be displayed in traditional indexed manor, or as named parameters
boolean	equals(java.lang.Object obj)
GroupSymbol	getGroup()
java.util.List	getInputParameters()
java.lang.Object	getModelID()
int	getNumberOfColumns()
SPParameter	getParameter(int index)
java.util.List	getParameters() Returns a List of SPParameter objects for this stored procedure
java.lang.String	getParamFullName(SPParameter param) Return the full parameter name for the indicated parameter of this stored procedure.
java.lang.String	getProcedureCallableName()
java.lang.Object	getProcedureID()
java.lang.String	getProcedureName() Get this stored procedure's name
java.util.Map	getProcedureParameters()
java.util.List	getProjectedSymbols() Get the ordered list of all elements returned by this query.
ElementSymbol	getResultSetColumn(int index)
java.util.List	getResultSetColumns()
int	getType() Return type of command.
int	hashCode()
boolean	isCallableStatement()
boolean	isProcedureRelational()
boolean	returnParameters()
boolean	returnsResultSet()
boolean	returnsScalarValue()
void	setCallableStatement(boolean isCallableStatement)
void	setDisplayNamedParameters(boolean displayNamedParameters) Indicate whether parameters should be displayed in traditional indexed manor, or as named parameters
void	setGroup(GroupSymbol group)
void	setModelID(java.lang.Object modelID)
void	setParameter(SPParameter parameter) Set a stored procedure's parameter
void	setProcedureCallableName(java.lang.String callableName)
void	setProcedureID(java.lang.Object procedureID)
void	setProcedureName(java.lang.String procedureName) Set this stored procedure's name
java.lang.String	toString() Returns a string representation of an instance of this class.

Methods inherited from class com.metamatrix.query.sql.lang.ProcedureContainer

copyMetadataState, getContainedCommands, getSubCommand, getUpdateCount, setSubCommand, setUpdateCount, updatingModelCount

Methods inherited from class com.metamatrix.query.sql.lang.Command

addExternalGroupsToContext, addExternalGroupToContext, getAllExternalGroups, getExternalGroupContexts, getOption, getSubCommands, getSubCommandsUpdatingModelCount, getSubCommandsUpdatingModelCount, getTemporaryMetadata, getUpdateCommandSymbol, getUpdatesCommandSymbol, getVariableValues, getVirtualGroup, isResolved, printCommandTree, printCommandTree, pushNewResolvingContext, setExternalGroupContexts, setIsResolved, setOption, setTemporaryMetadata, setVariableValues, setVirtualGroup

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StoredProcedure

public StoredProcedure()

Constructs a default instance of this class.

Method Detail

getType

public int getType()

Return type of command.

Specified by:

getType in class Command

Returns:

TYPE_STORED_PROCEDURE

setProcedureName

public void setProcedureName(java.lang.String procedureName)

Set this stored procedure's name

Parameters:

procedureName - the stored procedure's name

Throws:

IllegalArgumentExcecption - if the procedureName is invalid.

getProcedureName

public java.lang.String getProcedureName()

Get this stored procedure's name

Returns:

procedureName the stored procedure's name

getProcedureCallableName

public java.lang.String getProcedureCallableName()

setProcedureCallableName

public void setProcedureCallableName(java.lang.String callableName)

getModelID

public java.lang.Object getModelID()

setModelID

public void setModelID(java.lang.Object modelID)

setProcedureID

public void setProcedureID(java.lang.Object procedureID)

getProcedureID

public java.lang.Object getProcedureID()

setParameter

public void setParameter(SPParameter parameter)

Set a stored procedure's parameter

Parameters:

index - the index of the parameter to set

parameter - StoredProcedureParameter the parameter

Throws:

IllegalArgumentExcecption - if the parameters (index and parameter) are invalid.

getParameters

public java.util.List getParameters()

Returns a List of SPParameter objects for this stored procedure

getParameter

public SPParameter getParameter(int index)

getNumberOfColumns

public int getNumberOfColumns()

getResultSetColumn

public ElementSymbol getResultSetColumn(int index)

getResultSetColumns

public java.util.List getResultSetColumns()

acceptVisitor

public void acceptVisitor(LanguageVisitor visitor)

Description copied from interface: LanguageObject

Method for accepting a visitor. It is the responsibility of the language object to call back on the visitor.

Parameters:

visitor - Visitor being used

clone

public java.lang.Object clone()

Description copied from interface: LanguageObject

Implement clone to make objects cloneable.

Specified by:

clone in interface LanguageObject

Specified by:

clone in class Command

Returns:

Deep clone of this object

returnsResultSet

public boolean returnsResultSet()

returnsScalarValue

public boolean returnsScalarValue()

returnParameters

public boolean returnParameters()

getProjectedSymbols

public java.util.List getProjectedSymbols()

Get the ordered list of all elements returned by this query. These elements may be ElementSymbols or ExpressionSymbols but in all cases each represents a single column.

Specified by:

getProjectedSymbols in class Command

Returns:

Ordered list of SingleElementSymbol

toString

public java.lang.String toString()

Returns a string representation of an instance of this class.

Overrides:

toString in class Command

Returns:

String representation of object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clearParameters

public void clearParameters()

setGroup

public void setGroup(GroupSymbol group)

getGroup

public GroupSymbol getGroup()

Specified by:

getGroup in class ProcedureContainer

areResultsCachable

public boolean areResultsCachable()

Description copied from class: Command

Whether the results are cachable.

Specified by:

areResultsCachable in class Command

Returns:

True if the results are cachable; false otherwise.

See Also:

Command.areResultsCachable()

displayNamedParameters

public boolean displayNamedParameters()

Indicates whether parameters should be displayed in traditional indexed manor, or as named parameters

Returns:

Returns whether to display parameters as named or not

Since:

4.3

setDisplayNamedParameters

public void setDisplayNamedParameters(boolean displayNamedParameters)

Indicate whether parameters should be displayed in traditional indexed manor, or as named parameters

Parameters:

namedParameters - whether to display parameters as named or not

Since:

4.3

getParamFullName

public java.lang.String getParamFullName(SPParameter param)

Return the full parameter name for the indicated parameter of this stored procedure.

Parameters:

param -

Returns:

Since:

4.3

getInputParameters

public java.util.List getInputParameters()

isProcedureRelational

public boolean isProcedureRelational()

isCallableStatement

public boolean isCallableStatement()

setCallableStatement

public void setCallableStatement(boolean isCallableStatement)

getProcedureParameters

public java.util.Map getProcedureParameters()

Specified by:

getProcedureParameters in class ProcedureContainer

Since:

5.0

See Also:

ProcedureContainer.getProcedureParameters()