Package org.olap4j
Interface OlapParameterMetaData
- All Superinterfaces:
ParameterMetaData
,Wrapper
Extension to
ParameterMetaData
for parameters of OLAP statements.
Chief differences:
- An OLAP statement parameter has a name.
- An OLAP statement parameter may be a member. If this is the case,
the
ParameterMetaData.getParameterType(int)
method returnsTypes.OTHER
. - An additional method
getParameterOlapType(int)
provides extra type information; in particular, the hierarchy that a member parameter belongs to.
Parameters to an OLAP statement must have default values, and therefore it is not necessary to set every parameter.
- Since:
- Oct 12, 2006
- Author:
- jhyde
-
Field Summary
Fields inherited from interface java.sql.ParameterMetaData
parameterModeIn, parameterModeInOut, parameterModeOut, parameterModeUnknown, parameterNoNulls, parameterNullable, parameterNullableUnknown
-
Method Summary
Modifier and TypeMethodDescriptiongetParameterName
(int param) Returns the name of this parameter.getParameterOlapType
(int param) Retrieves the designated parameter's OLAP type.Methods inherited from interface java.sql.ParameterMetaData
getParameterClassName, getParameterCount, getParameterMode, getParameterType, getParameterTypeName, getPrecision, getScale, isNullable, isSigned
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
Method Details
-
getParameterName
Returns the name of this parameter.- Parameters:
param
- the first parameter is 1, the second is 2, ...- Returns:
- parameter name
- Throws:
OlapException
- if a database access error occurs
-
getParameterOlapType
Retrieves the designated parameter's OLAP type.- Parameters:
param
- the first parameter is 1, the second is 2, ...- Returns:
- OLAP type
- Throws:
OlapException
- if a database access error occurs
-