1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.internal.macro.chart.source

File DataSource.java

 

Code metrics

0
0
0
1
64
15
0
-
-
0
-

Classes

Class Line # Actions
DataSource 36 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.rendering.internal.macro.chart.source;
21   
22    import java.util.Map;
23   
24    import org.xwiki.chart.model.ChartModel;
25    import org.xwiki.component.annotation.Role;
26    import org.xwiki.rendering.macro.MacroExecutionException;
27    import org.xwiki.rendering.transformation.MacroTransformationContext;
28   
29    /**
30    * A data source is able to provide a data set for chart generation.
31    *
32    * @version $Id: cdc408c4611736a7567b586e80b62558359e0798 $
33    * @since 4.2M1
34    */
35    @Role
 
36    public interface DataSource
37    {
38    /**
39    * Parameter identifier for data source.
40    */
41    String SOURCE_PARAM = "source";
42    /**
43    * Parameter identifier for data source specific parameters.
44    */
45    String PARAMS_PARAM = "params";
46   
47    /**
48    * Decodes the given macroContent / extraParams and builds a Data Set.
49    *
50    * @param macroContent the content of the macro
51    * @param parameters the parameters provided for the source
52    * @param context the macro transformation context, used for example to find out the current document reference
53    * @throws MacroExecutionException if something goes wrong while decoding source / parameters
54    */
55    void buildDataset(String macroContent, Map<String, String> parameters, MacroTransformationContext context)
56    throws MacroExecutionException;
57   
58    /**
59    * {@link #buildDataset} must be called before this method.
60    *
61    * @return the {@link ChartModel} for the dataset.
62    */
63    ChartModel getChartModel();
64    }