org.eclipse.birt.data.engine.api
Interface IParameterMetaData

public interface IParameterMetaData

Describes the metadata of a parameter in an IPreparedQuery. A parameter's metadata is defined based on a query's runtime meta-data (as described by underlying its data source driver), merging with static input and output parameter hints specified in a data set design.

Method Summary

int	getDataType() Returns the data type of this parameter.
java.lang.String	getDataTypeName() Returns the data type name of this parameter.
java.lang.String	getDefaultInputValue() Returns the default value of this input parameter.
java.lang.String	getName() Returns the name of this parameter.
java.lang.String	getNativeTypeName() Returns the data provider specific data type name of this parameter.
int	getPosition() Returns the 1-based parameter position of this parameter, as defined by the underlying data provider.
int	getPrecision() Returns the maximum number of decimal digits of this parameter.
int	getScale() Returns the maximum number of digits to the right of the decimal point of this parameter.
java.lang.Boolean	isInputMode() Returns whether this parameter is an input parameter.
java.lang.Boolean	isNullable() Returns whether a null value is allowed for this parameter.
java.lang.Boolean	isOptional() Returns whether this parameter is optional.
java.lang.Boolean	isOutputMode() Returns whether this parameter is an output parameter.

Method Detail

isInputMode

java.lang.Boolean isInputMode()

Returns whether this parameter is an input parameter. A parameter can be of both input and output modes.

Returns:

true if this parameter is an input parameter, false if it is output only, or null if its input mode is unknown.

isOutputMode

java.lang.Boolean isOutputMode()

Returns whether this parameter is an output parameter. A parameter can be of both input and output modes.

Returns:

true if this parameter is an output parameter, false if it is input only, or null if its output mode is unknown.

getName

java.lang.String getName()

Returns the name of this parameter.

Returns:

the parameter name of this parameter, or null if the name is non-specified or unknown.

getPosition

int getPosition()

Returns the 1-based parameter position of this parameter, as defined by the underlying data provider. Not all data source parameters are defined with a position value.

Returns:

the 1-based parameter position of this parameter, or -1 if the position is non-specified or unknown.

getDataType

int getDataType()
                throws org.eclipse.birt.core.exception.BirtException

Returns the data type of this parameter.

Returns:

The data type of this parameter, as an integer defined in org.eclipse.birt.core.data.DataType.

Throws:

DataException

org.eclipse.birt.core.exception.BirtException

getDataTypeName

java.lang.String getDataTypeName()
                                 throws org.eclipse.birt.core.exception.BirtException

Returns the data type name of this parameter.

Returns:

The data type name of this parameter.

Throws:

DataException

org.eclipse.birt.core.exception.BirtException

isOptional

java.lang.Boolean isOptional()

Returns whether this parameter is optional.

Returns:

true if this parameter is optional, false if this parameter is required, null if unknown.

getDefaultInputValue

java.lang.String getDefaultInputValue()

Returns the default value of this input parameter.

Returns:

the default value if known, null if not specified or if this is an output only parameter.

getNativeTypeName

java.lang.String getNativeTypeName()

Returns the data provider specific data type name of this parameter.

Returns:

the data type name as defined by the data provider.

getScale

int getScale()

Returns the maximum number of digits to the right of the decimal point of this parameter.

Returns:

the scale of the parameter, or -1 if the scale is not specified or unknown.

getPrecision

int getPrecision()

Returns the maximum number of decimal digits of this parameter.

Returns:

the precision of the parameter, or -1 if the scale is not specified or unknown.

isNullable

java.lang.Boolean isNullable()

Returns whether a null value is allowed for this parameter.

Returns:

true if null is allowed for this parameter, false if null is not allowed, or null if its nullability is not specified or unknown.