com.metamatrix.metadata.runtime.model
Class BasicProcedureParameter

java.lang.Object
  com.metamatrix.metadata.runtime.model.BasicProcedureParameter

All Implemented Interfaces:

ProcedureParameter

public class BasicProcedureParameter
extends java.lang.Object
implements ProcedureParameter

Constructor Summary

BasicProcedureParameter(java.lang.String name)

BasicProcedureParameter(java.lang.String name, BasicProcedureID procedureID)

BasicProcedureParameter(java.lang.String name, BasicProcedureID procedureID, DataType dType, short paramType, int paramPosition, int resultSetPosition, boolean isOpitional)
Call constructor to instantiate a procedure parameter object by passing the name that identifies the entity.

Method Summary

DataType	getActualDataType()
DataType	getDataType() Returns the DataType this parameter will be represented as.
java.lang.String	getDefaultValue() Returns the default value of parameter if it is optional.
java.lang.String	getName()
java.lang.String	getNameInSource() Override the super method so that when the name is returned, it is the name and not the full path for a parameter.
short	getParameterType() Return short indicating the type of parameter.
int	getPosition() Returns the order of parameter in relation to the other parameters that are of the same type for its procedure.
ProcedureID	getProcID() Returns the procID.
int	getResultSetPosition()
boolean	isOptional() Returns a boolean indicating if this parameter is optional.
void	setDataType(DataType dataType)
void	setDefaultValue(java.lang.String value)
void	setIsOptional(boolean optional)
void	setName(java.lang.String name)
void	setParameterType(short type)
void	setPosition(int pos)
void	setProcID(BasicProcedureID procID) Sets the procID.
void	setResultSetPosition(int resultSetPosition)
java.lang.String	toString() Returns a string representing the current state of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicProcedureParameter

public BasicProcedureParameter(java.lang.String name,
                               BasicProcedureID procedureID,
                               DataType dType,
                               short paramType,
                               int paramPosition,
                               int resultSetPosition,
                               boolean isOpitional)

Call constructor to instantiate a procedure parameter object by passing the name that identifies the entity.

BasicProcedureParameter

public BasicProcedureParameter(java.lang.String name)

BasicProcedureParameter

public BasicProcedureParameter(java.lang.String name,
                               BasicProcedureID procedureID)

Method Detail

getNameInSource

public java.lang.String getNameInSource()

Override the super method so that when the name is returned, it is the name and not the full path for a parameter.

getDataType

public DataType getDataType()

Description copied from interface: ProcedureParameter

Returns the DataType this parameter will be represented as.

Specified by:

getDataType in interface ProcedureParameter

Returns:

DataType

getActualDataType

public DataType getActualDataType()

getParameterType

public short getParameterType()

Description copied from interface: ProcedureParameter

Return short indicating the type of parameter.

Specified by:

getParameterType in interface ProcedureParameter

Returns:

short

See Also:

MetadataConstants.PARAMETER_TYPES

isOptional

public boolean isOptional()

Description copied from interface: ProcedureParameter

Returns a boolean indicating if this parameter is optional.

Specified by:

isOptional in interface ProcedureParameter

Returns:

boolean true when the parameter is optional

getPosition

public int getPosition()

Description copied from interface: ProcedureParameter

Returns the order of parameter in relation to the other parameters that are of the same type for its procedure.

Specified by:

getPosition in interface ProcedureParameter

Returns:

int postion

getResultSetPosition

public int getResultSetPosition()

Specified by:

getResultSetPosition in interface ProcedureParameter

getName

public java.lang.String getName()

Specified by:

getName in interface ProcedureParameter

getDefaultValue

public java.lang.String getDefaultValue()

Description copied from interface: ProcedureParameter

Returns the default value of parameter if it is optional.

Specified by:

getDefaultValue in interface ProcedureParameter

Returns:

int postion

setIsOptional

public void setIsOptional(boolean optional)

setPosition

public void setPosition(int pos)

setParameterType

public void setParameterType(short type)

setDataType

public void setDataType(DataType dataType)

setResultSetPosition

public void setResultSetPosition(int resultSetPosition)

setName

public void setName(java.lang.String name)

setDefaultValue

public void setDefaultValue(java.lang.String value)

getProcID

public ProcedureID getProcID()

Returns the procID.

Specified by:

getProcID in interface ProcedureParameter

Returns:

BasicProcedureID

setProcID

public void setProcID(BasicProcedureID procID)

Sets the procID.

Parameters:

procID - The procID to set

toString

public java.lang.String toString()

Returns a string representing the current state of the object.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this instance.