org.eclipse.birt.report.model.api.elements.structures
Class OdaDataSetParameter

java.lang.Object
  extended by org.eclipse.birt.report.model.core.Structure
      extended by org.eclipse.birt.report.model.api.elements.structures.DataSetParameter
          extended by org.eclipse.birt.report.model.api.elements.structures.OdaDataSetParameter
All Implemented Interfaces:
java.lang.Cloneable, IStructure, org.eclipse.birt.report.model.core.IPropertySet

public class OdaDataSetParameter
extends DataSetParameter

Represents the parameter for ODA drivers.


Field Summary
static java.lang.String NATIVE_DATA_TYPE_MEMBER
          Name of the member indicating the native (database) data type code.
static java.lang.String NATIVE_NAME_MEMBER
          The native name from oda parameter.
static java.lang.String PARAM_NAME_MEMBER
          The parameter name used to refer to a report parameter.
static java.lang.String STRUCT_NAME
          Name of this structure.
 
Fields inherited from class org.eclipse.birt.report.model.api.elements.structures.DataSetParameter
ALLOW_NULL_MEMBER, DATA_TYPE_MEMBER, DEFAULT_VALUE_MEMBER, IS_INPUT_MEMBER, IS_NULLABLE_MEMBER, IS_OPTIONAL_MEMBER, IS_OUTPUT_MEMBER, NAME_MEMBER, POSITION_MEMBER
 
Constructor Summary
OdaDataSetParameter()
           
 
Method Summary
protected  java.lang.Object getIntrinsicProperty(java.lang.String propName)
           
 java.lang.Integer getNativeDataType()
          Returns the native data type.
 java.lang.String getNativeName()
          returns the native parameter name.
 java.lang.String getParamName()
          returns the report parameter name.
 java.lang.String getStructName()
          Returns the name of the structure definition.
 StructureHandle handle(SimpleValueHandle valueHandle, int index)
           
protected  void setIntrinsicProperty(java.lang.String propName, java.lang.Object value)
           
 void setNativeDataType(java.lang.Integer dataType)
          Sets the parameter native data type.
 void setNativeName(java.lang.String name)
          set the native oda dataset parameter name.
 void setParamName(java.lang.String name)
          set the refered report parameter name.
 
Methods inherited from class org.eclipse.birt.report.model.api.elements.structures.DataSetParameter
allowNull, getDataType, getDefaultValue, getName, getParameterDataType, getPosition, isInput, isNullable, isOptional, isOutput, setAllowNull, setDataType, setDefaultValue, setIsInput, setIsNullable, setIsOptional, setIsOutput, setName, setParameterDataType, setPosition, validate
 
Methods inherited from class org.eclipse.birt.report.model.core.Structure
copy, equals, getContext, getDefn, getElement, getHandle, getHandle, getListMemberRef, getLocalProperty, getLocalProperty, getObjectDefn, getProperty, getProperty, getReferencableProperty, isDesignTime, isReferencable, setContext, setProperty, setProperty, updateReference
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STRUCT_NAME

public static final java.lang.String STRUCT_NAME
Name of this structure. Matches the definition in the meta-data dictionary.

See Also:
Constant Field Values

PARAM_NAME_MEMBER

public static final java.lang.String PARAM_NAME_MEMBER
The parameter name used to refer to a report parameter.

See Also:
Constant Field Values

NATIVE_NAME_MEMBER

public static final java.lang.String NATIVE_NAME_MEMBER
The native name from oda parameter.

See Also:
Constant Field Values

NATIVE_DATA_TYPE_MEMBER

public static final java.lang.String NATIVE_DATA_TYPE_MEMBER
Name of the member indicating the native (database) data type code.

See Also:
Constant Field Values
Constructor Detail

OdaDataSetParameter

public OdaDataSetParameter()
Method Detail

handle

public StructureHandle handle(SimpleValueHandle valueHandle,
                              int index)
Overrides:
handle in class DataSetParameter

getIntrinsicProperty

protected java.lang.Object getIntrinsicProperty(java.lang.String propName)
Overrides:
getIntrinsicProperty in class DataSetParameter

setIntrinsicProperty

protected void setIntrinsicProperty(java.lang.String propName,
                                    java.lang.Object value)
Overrides:
setIntrinsicProperty in class DataSetParameter

setParamName

public void setParamName(java.lang.String name)
set the refered report parameter name.

Parameters:
name - the parameter name

setNativeName

public void setNativeName(java.lang.String name)
set the native oda dataset parameter name.

Parameters:
name - the native name

getParamName

public java.lang.String getParamName()
returns the report parameter name.

Returns:
report parameter name

getNativeName

public java.lang.String getNativeName()
returns the native parameter name.

Returns:
native parameter name

getStructName

public java.lang.String getStructName()
Description copied from interface: IStructure
Returns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.

Specified by:
getStructName in interface IStructure
Overrides:
getStructName in class DataSetParameter
Returns:
the internal name of the structure a defined in the meta-data dictionary.

getNativeDataType

public java.lang.Integer getNativeDataType()
Returns the native data type.

Overrides:
getNativeDataType in class DataSetParameter
Returns:
the parameter native data type.

setNativeDataType

public void setNativeDataType(java.lang.Integer dataType)
Sets the parameter native data type.

Overrides:
setNativeDataType in class DataSetParameter
Parameters:
dataType - the native data type to set.


Copyright © 2008 Actuate Corp. All rights reserved.