Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api
Class ParamBindingHandle

    java.lang.Object
      org.eclipse.birt.report.model.api.ElementDetailHandle
          org.eclipse.birt.report.model.api.ValueHandle
              org.eclipse.birt.report.model.api.StructureHandle
                  org.eclipse.birt.report.model.api.ParamBindingHandle

    public class ParamBindingHandle

extends StructureHandle

Represents the handle of parameter binding. The parameter binding binds data set input parameter to expression by position. Order of these bindings must match the order of parameter markers ("?"") in the statement. Each parameter binding has the following properties:

Parameter Name
  a parameter bing has a required parameter name to bind.
Expression
  associated an expression with a named input parameter.

Field Summary

Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
`structRef`

Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
`elementHandle`

Constructor Summary
`ParamBindingHandle(SimpleValueHandle valueHandle, int index)` Constructs the handle of parameter binding.

Method Summary
`java.lang.String` | `getExpression()` Returns the expression the parameter is binded to.
`java.lang.String` | `getParamName()` Returns the parameter name.
`void` | `setExpression(java.lang.String expression)` Sets the expression the parameter is binded to.
`void` | `setParamName(java.lang.String name)` Sets the parameter name.

Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
`drop, getDefn, getExternalizedValue, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently`

Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
`getDesign, getElement, getElementHandle, getModule`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### ParamBindingHandle

    public ParamBindingHandle(SimpleValueHandle valueHandle,
                              int index)

  Constructs the handle of parameter binding.

  Parameters:
    `valueHandle` - the value handle for parameter binding list of one property
    `index` - the position of this parameter binding in the list

Method Detail

### getExpression

    public java.lang.String getExpression()

  Returns the expression the parameter is binded to.

  Returns:
    the expression the parameter is binded to

### setExpression

    public void setExpression(java.lang.String expression)

  Sets the expression the parameter is binded to.

  Parameters:
    `expression` - the expression to bind

### getParamName

    public java.lang.String getParamName()

  Returns the parameter name.

  Returns:
    the parameter name

### setParamName

    public void setParamName(java.lang.String name)

  Sets the parameter name.

  Parameters:
    `name` - the parameter name to set

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.