org.eclipse.birt.chart.engine.datasetprocessors.html from BIRT at Krugle

Show org.eclipse.birt.chart.engine.datasetprocessors.html syntax highlighted

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Contains definition of chart DataSet processors</title>
<style>@import url("file:/c:/Program Files/eclipse3.1/plugins/org.eclipse.sdk_3.1.0/book.css");</style>
<style>@import url("file:/c:/Program Files/eclipse3.1/plugins/org.eclipse.platform.doc.isv_3.1.0/schema.css");</style>
</HEAD>
<BODY>
<H1><CENTER>Contains definition of chart DataSet processors</CENTER></H1>
<p></p>
<h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.birt.chart.engine.datasetprocessors<p></p>
<h6 class=CaptionFigColumn id=header>Since: </h6>1.0.0
<p></p>

<p>
<h6 class=CaptionFigColumn id=header>Description: </h6>A dataset processor extension point specifies a mapping entry between a series type identified by a fully qualified implementing class name against a class that is capable of processing each row of data provided in its dataset. For further information, please refer to the documentation provided for each extension point schema element</p>
<p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p>
<p class=code id=dtd>&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.datasetProcessor">datasetProcessor</a>)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST extension</p>
<p class=code id=dtdAttlist>point&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<ul class=ConfigMarkup id=attlistDesc>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.datasetProcessor">datasetProcessor</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST datasetProcessor</p>
<p class=code id=dtdAttlist>series&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>processor&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
A dataset processor extension point specifies a mapping entry between a series type identified by a fully qualified implementing class name against a class that is capable of processing each row of data provided in its dataset. Note that all dataset processor implementations must subclass the base dataset processor implementation provided i.e. org.eclipse.birt.chart.datafeed.DataSetAdapter and override methods as needed. A dataset processor is responsible for introspecting each row of custom data that may be provided in a dataset for use in series rendering.</p>
<br>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>series</b> - The series type class name for which a dataset processor is being defined. Series class implementations are located at org.eclipse.birt.chart.model.type.impl.*

e.g.
org.eclipse.birt.chart.model.type.impl.BarSeriesImpl</li>
<li><b>processor</b> - The dataset processor implementation class name responsible for rendering the specific series type along with its data set. The dataset processor class is typically provided by an extension writer for complex rows of data containing multiple numeric values that may be mapped to a numeric scale.

e.g.
org.eclipse.birt.chart.datafeed.StockDataSetProcessorImpl</li>
</ul>
<br><h6 class=CaptionFigColumn id=header>Examples: </h6><extension
         point="org.eclipse.birt.chart.engine.datasetprocessors">
      <datasetProcessor
            processor="org.eclipse.birt.chart.datafeed.DataSetProcessorImpl"
            series="org.eclipse.birt.chart.model.component.impl.SeriesImpl"/>
      <datasetProcessor
            processor="org.eclipse.birt.chart.datafeed.DataSetProcessorImpl"
            series="org.eclipse.birt.chart.model.type.impl.BarSeriesImpl"/>
      <datasetProcessor
            processor="org.eclipse.birt.chart.datafeed.DataSetProcessorImpl"
            series="org.eclipse.birt.chart.model.type.impl.LineSeriesImpl"/>
      <datasetProcessor
            processor="org.eclipse.birt.chart.datafeed.DataSetProcessorImpl"
            series="org.eclipse.birt.chart.model.type.impl.PieSeriesImpl"/>
      <datasetProcessor
            processor="org.eclipse.birt.chart.datafeed.StockDataSetProcessorImpl"
            series="org.eclipse.birt.chart.model.type.impl.StockSeriesImpl"/>
      <datasetProcessor
            processor="org.eclipse.birt.chart.datafeed.DataSetProcessorImpl"
            series="org.eclipse.birt.chart.model.type.impl.ScatterSeriesImpl"/>
   </extension>
<p></p>

<h6 class=CaptionFigColumn id=header>API Information: </h6>Please refer to the IDataSetProcessor interface javadocs in <i>org.eclipse.birt.chart.datafeed</i> package.
<p></p>

<h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>The <i>org.eclipse.birt.chart.engine.extension</i> plug-in defines DataSetProcessor extensions for the default series types.
<p></p>

<br>
<p class=note id=copyright>
Copyright (c) 2004-2005 Actuate Corporation.
All rights reserved. This program and the accompanying materials are made available under the  terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html
<p></p>

</p>
</BODY>
</HTML>
See more files for this project here