org.exolab.castor.jdo.oql

Class ParamInfo

public class ParamInfo extends Object

A class to store and check information about numbered query parameters.

Version: $Revision: 1.1.1.1 $ $Date: 2003/03/03 07:08:23 $

Author: Nissim Karpenstein

Constructor Summary
ParamInfo(String userDefinedType, String systemType, JDOFieldDescriptor desc)
Creates a new ParamInfo.
Method Summary
voidcheck(String userDefinedType, String systemType)
Checks whether the userDefinedType and systemType match those previousle specified in the constructor.
TypeConvertorgetConvertor()
StringgetConvertorParam()
Returns the convertor parameter.
ClassgetFieldType()
Returns the Java field type
VectorgetParamMap()
Accessor method for _sqlQueryParamMap.
ClassgetSQLType()
Returns the SQL type
ClassgetTheClass()
Accessor method for _class.
booleanisUserDefined()
Specifies whether this parameter was specified in the OQL with a User defined type, like $(int)1.
voidmapToSQLParam(int sqlParamIndex)
Maps this numbered parameter to the numbered SQL parameter.

Constructor Detail

ParamInfo

public ParamInfo(String userDefinedType, String systemType, JDOFieldDescriptor desc)
Creates a new ParamInfo. Which checks for incompatibilities between types.

Parameters: userDefinedType The user defined type, empty string if undefined. systemType The system generated type

Throws: QueryException if the user defined type cannot be converted to the systemType or if the type is not found.

Method Detail

check

public void check(String userDefinedType, String systemType)
Checks whether the userDefinedType and systemType match those previousle specified in the constructor.

Parameters: userDefinedType The user defined type, empty string if undefined. systemType The system generated type

Throws: QueryException if the user defined type is not the same as the one prevuiously specified in the constructor, or if the systemType is not convertable to the original systemType.

getConvertor

public TypeConvertor getConvertor()

Returns: Convertor that converts from the parameter type to SQL type of the parameter, if the latter is defined and not equal to the parameter class, otherwise returns null.

getConvertorParam

public String getConvertorParam()
Returns the convertor parameter.

Returns: Convertor parameter

getFieldType

public Class getFieldType()
Returns the Java field type

Returns: Java field type

getParamMap

public Vector getParamMap()
Accessor method for _sqlQueryParamMap.

Returns: private member _sqlQueryParamMap.

getSQLType

public Class getSQLType()
Returns the SQL type

Returns: SQL type

getTheClass

public Class getTheClass()
Accessor method for _class.

Returns: private member _class

isUserDefined

public boolean isUserDefined()
Specifies whether this parameter was specified in the OQL with a User defined type, like $(int)1.

Returns: True if this parameter whas a user defined type otherwise false

mapToSQLParam

public void mapToSQLParam(int sqlParamIndex)
Maps this numbered parameter to the numbered SQL parameter.

Parameters: sqlParamIndex The SQL parameter number.

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com