org.olap4j
Interface OlapParameterMetaData

All Superinterfaces:
ParameterMetaData, Wrapper

public interface OlapParameterMetaData
extends ParameterMetaData

Extension to ParameterMetaData for parameters of OLAP statements.

Chief differences:

Parameters to an OLAP statement must have default values, and therefore it is not necessary to set every parameter.

Since:
Oct 12, 2006
Version:
$Id: OlapParameterMetaData.java 482 2012-01-05 23:27:27Z jhyde $
Author:
jhyde

Field Summary
 
Fields inherited from interface java.sql.ParameterMetaData
parameterModeIn, parameterModeInOut, parameterModeOut, parameterModeUnknown, parameterNoNulls, parameterNullable, parameterNullableUnknown
 
Method Summary
 String getParameterName(int param)
          Returns the name of this parameter.
 Type 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 Detail

getParameterName

String getParameterName(int param)
                        throws OlapException
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

Type getParameterOlapType(int param)
                          throws OlapException
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

SourceForge.net_Logo