Package org.olap4j
Interface OlapParameterMetaData
-
- All Superinterfaces:
java.sql.ParameterMetaData
,java.sql.Wrapper
public interface OlapParameterMetaData extends java.sql.ParameterMetaData
Extension toParameterMetaData
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getParameterName(int param)
Returns the name of this parameter.Type
getParameterOlapType(int param)
Retrieves the designated parameter's OLAP type.
-
-
-
Method Detail
-
getParameterName
java.lang.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
-
-