報(bào)表參數(shù)的獲取與配置詳解
報(bào)表是有參數(shù)的,通過報(bào)表參數(shù)可以使用程序進(jìn)行獲取和配置。參數(shù)是報(bào)表生成之前想報(bào)表設(shè)計(jì)文件輸入的報(bào)表元素。報(bào)表的應(yīng)用程序可以訪問報(bào)表的參數(shù)的屬性,最常用的屬性是name和value,你可以使用參數(shù)名或通用編碼來獲取參數(shù)。
為報(bào)表設(shè)計(jì)創(chuàng)建一個(gè)參數(shù)定義任務(wù)
一個(gè)IGetParameterDefinitionTask對(duì)象提供鏈接到報(bào)表設(shè)計(jì)所有參數(shù)的接口。通過調(diào)用 ReportEngine.createGetParameterDefinitionTask( )創(chuàng)建一個(gè)參數(shù)定義對(duì)象,使用結(jié)束后調(diào)用他的close方法關(guān)閉。
測試報(bào)表設(shè)計(jì)是否有參數(shù)
IGetParameterDefinitionTask.getParameterDefns( )可以測試報(bào)表設(shè)計(jì)是否有參數(shù),它返回一個(gè)參數(shù)集合,調(diào)用集合的isEmpty( )方法可以測試集合中是否有元素。
獲取報(bào)表設(shè)計(jì)的參數(shù)
通過IGetParameterDefinitionTask.getParameterDefn( )方法獲取一個(gè)已知名字的參數(shù),它返回一個(gè)IParameterDefnBase類型對(duì)象,也可以調(diào)用getParameterDefns( )方法返回一個(gè)參數(shù)集合。
getParameterDefns( )需要一個(gè)boolean參數(shù),如果為false返回一個(gè)未分組的參數(shù)集合,如果為true返回報(bào)表設(shè)計(jì)中定義的參數(shù)組。
調(diào)用IParameterDefnBase.getParameterType( )可以檢驗(yàn)參數(shù)是否是一個(gè)組。如果是一個(gè)組則返回IParameterDefnBase.PARAMETER_GROUP,如果是一個(gè)級(jí)聯(lián)參數(shù)組則返回 IParameterDefnBase.CASCADING_PARAMETER_GROUP。為獲取一組報(bào)表參數(shù),使用方法 IParameterGroupDefn.getContents( ),它返回一個(gè)數(shù)據(jù)類型是IScalarParameterDefn的ArrayList對(duì)象。
獲取報(bào)表參數(shù)的默認(rèn)值
這個(gè)任務(wù)是可選的。調(diào)用IGetParameterDefinitionTask.getDefaultValue( )獲取一個(gè)已知參數(shù)的默認(rèn)值,它返回的是一個(gè)Object??梢酝ㄟ^調(diào)用IScalarParameterDefn.getDataType( )來獲取Object的有效類型,它返回一個(gè)IScalarParameterDefn定義的int類型的靜態(tài)變量。調(diào)用 IGetParameterDefinitionTask.getDefaultValues( )來獲取報(bào)表設(shè)計(jì)的所有參數(shù)的默認(rèn)值,它返回一個(gè)HashMap對(duì)象存儲(chǔ)了從參數(shù)名到默認(rèn)值的映射。
使用常量列表提供的效值
許多報(bào)表參數(shù)只接受常量列表的值,這些值可能是靜態(tài)常量,也可能是數(shù)據(jù)庫里查出來的數(shù)據(jù)list。使用 IGetParameterDefinitionTask.getSelectionList( )可以返回參數(shù)所能接受的參數(shù)(IParameterSelectionChoice)的集合,如果集合為null,則可以接受任何值。 IParameterSelectionChoice的getLabel( )方法返回現(xiàn)實(shí)的文本,getValue( )返回值。
獲取每個(gè)報(bào)表參數(shù)的屬性
這個(gè)任務(wù)是可選的。使用IScalarParameterDefn的方法可以獲取表參數(shù)的屬性。應(yīng)用程序使用屬性生成用戶自定義接口。例如,獲取參數(shù)的數(shù)據(jù)類型使用getDataType( )方法。
為參數(shù)設(shè)置值
調(diào)用IGetParameterDefinitionTask.setParameterValue( )為參數(shù)設(shè)置值。如果你是通過應(yīng)用程為日期數(shù)值等參數(shù)返回一個(gè)字符串,要把他們轉(zhuǎn)化成和本地?zé)o關(guān)的格式。調(diào)用方法 ReportParameterConverter.parse( )方法可以完成這項(xiàng)工作。getParameterValues( )方法返回一個(gè)HashMap包含了已經(jīng)設(shè)置的所有參數(shù)。
報(bào)表參數(shù)設(shè)置實(shí)例
下面的代碼展示了如何設(shè)置一個(gè)已知參數(shù)名的參數(shù)值:
- // Create a parameter definition task.
- IGetParameterDefinitionTask task = engine.createGetParameterDefinitionTask( runnable );
- // Instantiate a scalar parameter.
- IScalarParameterDefn param = (IScalarParameterDefn)
- task.getParameterDefn( "customerID" );
- // Get the default value of the parameter. In this case,
- // the data type of the parameter, customerID, is Double.
- int customerID = ((Double) task.getDefaultValue( param )).intValue( );
- // Get a value for the parameter. This example assumes that
- // this step creates a correctly typed object, inputValue.
- // Set the value of the parameter.
- task.setParameterValue( "customerID", inputValue );
- // Get the values set by the application for all parameters.
- HashMap parameterValues = task.getParameterValues( );
- // Close the parameter definition task.
- task.close( );
- // Create a parameter definition task.
- IGetParameterDefinitionTask task = engine.createGetParameterDefinitionTask( runnable );
- // Instantiate a scalar parameter.
- IScalarParameterDefn param = (IScalarParameterDefn)
- task.getParameterDefn( "customerID" );
- // Get the default value of the parameter. In this case,
- // the data type of the parameter, customerID, is Double.
- int customerID = ((Double) task.getDefaultValue( param )).intValue( );
- // Get a value for the parameter. This example assumes that
- // this step creates a correctly typed object, inputValue.
- // Set the value of the parameter.
- task.setParameterValue( "customerID", inputValue );
- // Get the values set by the application for all parameters.
- HashMap parameterValues = task.getParameterValues( );
- // Close the parameter definition task.
- task.close( );
下面的代碼展示了如何使用報(bào)表參數(shù)集合,例子中使用ReportParameterConverter將字符串轉(zhuǎn)化成用戶接口接受的參數(shù)格式。
- // Create a parameter definition task.
- IGetParameterDefinitionTask task = engine.createGetParameterDefinitionTask( runnable );
- // Create a collection of the parameters in the report design.
- Collection params = task.getParameterDefns( false );
- // Get the default values of the parameters.
- HashMap parameterValues = task.getDefaultValues( );
- // Get values for the parameters. Later code in this example
- // assumes that this step creates a HashMap object,
- // inputValues. The keys in the HashMap are the parameter
- // names and the values are those that the user provided.
- // Iterate through the report parameters, setting the values
- // in standard locale-independent format.
- Iterator iterOuter = params.iterator( );
- ReportParameterConverter cfgConverter =
- new ReportParameterConverter( "", Locale.getDefault() );
- while ( iterOuter.hasNext( ) ) {
- IParameterDefnBase param = (IParameterDefnBase) iterOuter.next( );
- String value = (String) inputValues.get( param.getName( ));
- if ( value != null ) {
- parameterValues.put( param.getName( ),
- cfgConverter.parse( value, param.getDataType( ) ) );
- }
- }
- // Close the parameter definition task.
- task.close( );
- // Create a parameter definition task.
- IGetParameterDefinitionTask task = engine.createGetParameterDefinitionTask( runnable );
- // Create a collection of the parameters in the report design.
- Collection params = task.getParameterDefns( false );
- // Get the default values of the parameters.
- HashMap parameterValues = task.getDefaultValues( );
- // Get values for the parameters. Later code in this example
- // assumes that this step creates a HashMap object,
- // inputValues. The keys in the HashMap are the parameter
- // names and the values are those that the user provided.
- // Iterate through the report parameters, setting the values
- // in standard locale-independent format.
- Iterator iterOuter = params.iterator( );
- ReportParameterConverter cfgConverter =
- new ReportParameterConverter( "", Locale.getDefault() );
- while ( iterOuter.hasNext( ) ) {
- IParameterDefnBase param = (IParameterDefnBase) iterOuter.next( );
- String value = (String) inputValues.get( param.getName( ));
- if ( value != null ) {
- parameterValues.put( param.getName( ),
- cfgConverter.parse( value, param.getDataType( ) ) );
- }
- }
- // Close the parameter definition task.
- task.close( );
使用級(jí)聯(lián)參數(shù)
級(jí)聯(lián)參數(shù)參數(shù)是一組可供用戶選擇的參數(shù)值的集合。第一個(gè)參數(shù)的選擇會(huì)影響到第二個(gè)參數(shù)中的值。參數(shù)使用一個(gè)或多個(gè)查詢來從數(shù)據(jù)集把數(shù)據(jù)展示給用戶。參數(shù)定義任務(wù)根據(jù)前面的選擇以行為單位過濾參數(shù)組中的數(shù)據(jù)。
使用報(bào)表引擎實(shí)現(xiàn)級(jí)聯(lián)參數(shù),要進(jìn)行如下工作:
■使用IGetParameterDefinitionTask.evaluateQuery( )方法為級(jí)聯(lián)參數(shù)準(zhǔn)備數(shù)據(jù),它需要參數(shù)group的名字作為參數(shù)。
■調(diào)用IGetParameterDefinitionTask.getSelectionListForCascadingGroup( )獲取參數(shù)組的第一個(gè)參數(shù)的值,它需要兩個(gè)參數(shù),參數(shù)名和對(duì)象數(shù)組,對(duì)第一個(gè)參數(shù)來說這個(gè)數(shù)組是空的。該方法返回一個(gè) IParameterSelectionChoice集合。
■ 再次調(diào)用getSelectionListForCascadingGroup( )方法獲取后面的參數(shù),這次Object[ ]中放的是前面獲取的參數(shù)值。
下面的代碼展示了如何通過查詢實(shí)現(xiàn)級(jí)聯(lián)參數(shù):
- // Create a grouped collection of the design’s parameters.
- Collection params = task.getParameterDefns( true );
- // Iterate through the parameters to find the cascading group.
- Iterator iter = params.iterator( );
- while ( iter.hasNext( ) ) {
- IParameterDefnBase param = (IParameterDefnBase) iter.next();
- if ( param.getParameterType() ==
- IParameterDefnBase.CASCADING_PARAMETER_GROUP ) {
- ICascadingParameterGroup group = (ICascadingParameterGroup) param;
- Iterator i2 = group.getContents( ).iterator( );
- // Run the query for the cascading parameters.
- task.evaluateQuery( group.getName() );
- Object[ ] userValues = new Object[group.getContents( ).size( )];
- // Get the report parameters in the cascading group.
- int i = 0;
- while ( i2.hasNext( ) ) {
- IScalarParameterDefn member = (IScalarParameterDefn) i2.next( );
- // Get the values for the parameter.
- Object[ ] setValues = new Object[i];
- if ( i > 0 ) System.arraycopy( userValues, 0, setValues, 0, i );
- Collection c = task.getSelectionListForCascadingGroup(
- group.getName(),setValues );
- // Iterate through the values for the parameter.
- Iterator i3 = c.iterator();
- while ( i3.hasNext( ) ) {
- IParameterSelectionChoice s =
- ( IParameterSelectionChoice ) i3.next( );
- String choiceValue = s.getValue( );
- String choiceLabel = s.getLabel( );
- }
- // Get the value for the parameter from the list of
- // choices. This example does not provide the code for
- // this task.
- userValues[i] = inputChoiceValue;
- i++;
- }
- }
- }
以上就是用程序處理報(bào)表參數(shù)的配置方法。
【編輯推薦】