org.eclipse.birt.report.model.api
Class DataSourceParamBindingHandle

java.lang.Object
  extended byorg.eclipse.birt.report.model.api.ElementDetailHandle
      extended byorg.eclipse.birt.report.model.api.ValueHandle
          extended byorg.eclipse.birt.report.model.api.StructureHandle
              extended byorg.eclipse.birt.report.model.api.DataSourceParamBindingHandle

public class DataSourceParamBindingHandle
extends StructureHandle

Represents the handle of datasource parameter binding. The parameter binding maps a data source and its properties to expressions. Each parameter binding has the following properties:

Datasource Name
a datasource parameter bing has a required datasource name to bind.
Property bindings
a list of parameter bindings.


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
DataSourceParamBindingHandle(SimpleValueHandle valueHandle, int index)
          Constructors a data source parameter handle
 
Method Summary
 void addParamBinding(ParamBinding paramBinding)
          Add a new parameter binding to the action.
 java.lang.String getDataSourceName()
          Get the data source name member.
 MemberHandle getParamBindings()
          Get a handle to deal with the parameter binding list member.
 java.util.Iterator paramBindingsIterator()
          Gets the parameter binding list of a data source.
 void setDataSourceName(java.lang.String dsName)
          Set the data source name member.
 
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getDefn, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, iterator, 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

DataSourceParamBindingHandle

public DataSourceParamBindingHandle(SimpleValueHandle valueHandle,
                                    int index)
Constructors a data source parameter handle

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

getDataSourceName

public java.lang.String getDataSourceName()
Get the data source name member.

Returns:
the cached data source name member.

setDataSourceName

public void setDataSourceName(java.lang.String dsName)
                       throws SemanticException
Set the data source name member.

Parameters:
dsName - the data source name
Throws:
SemanticException

paramBindingsIterator

public java.util.Iterator paramBindingsIterator()
Gets the parameter binding list of a data source. Each one is the instance of ParameBindingHandle Note that this is a parameter binding, not a parameter definition. The report makes no attempt to check that the parameters listed here are accurate in name or type for the target report. Also, it is legal to bind the same parameter multiple times; the meaning depends on the semantics of the target report.

Returns:
the iterator over parameter bindings of the data source.

getParamBindings

public MemberHandle getParamBindings()
Get a handle to deal with the parameter binding list member.

Returns:
a handle to deal with the parameter binding list member

addParamBinding

public void addParamBinding(ParamBinding paramBinding)
                     throws SemanticException
Add a new parameter binding to the action.

Parameters:
paramBinding - a new parameter binding to be added.
Throws:
SemanticException - if the parameter binding is not valid


Copyright © 2005 Actuate Corp. All rights reserved.