|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.chart.factory.Generator
Provides an entry point into building a chart for a given model. It is implemented as a singleton and does not maintain any state information hence allowing multi-threaded requests for a single generator instance.
Method Summary | |
void |
bindData(IDataRowExpressionEvaluator expressionEvaluator,
Chart chart,
RunTimeContext rtc)
Binds data to the chart model using a row expression evaluator. |
void |
bindData(IDataRowExpressionEvaluator expressionEvaluator,
IActionEvaluator iae,
Chart chart,
RunTimeContext rtc)
Binds data to the chart model using a row expression evaluator. |
void |
bindData(java.sql.ResultSet resultSet,
Chart chart,
RunTimeContext rtc)
Binds a sql Resuset to a chart model. |
GeneratedChartState |
build(IDisplayServer ids,
Chart cmDesignTime,
Bounds bo,
IExternalContext externalContext,
RunTimeContext rtc,
IStyleProcessor externalProcessor)
Builds and computes preferred sizes of various chart components offscreen using the provided display server. |
GeneratedChartState |
build(IDisplayServer ids,
Chart cmDesignTime,
org.mozilla.javascript.Scriptable scParent,
Bounds bo,
RunTimeContext rtc)
Deprecated. |
GeneratedChartState |
build(IDisplayServer ids,
Chart cmDesignTime,
org.mozilla.javascript.Scriptable scParent,
Bounds bo,
RunTimeContext rtc,
IStyleProcessor externalProcessor)
Deprecated. |
java.util.List |
getRowExpressions(Chart cm)
This retrieves all the data row related expressions stored in the chart model. |
java.util.List |
getRowExpressions(Chart cm,
IActionEvaluator iae)
This retrieves all the row expressions stored in the chart model. |
static Generator |
instance()
Returns a singleton instance of the chart generator. |
RunTimeContext |
prepare(Chart model,
IExternalContext externalContext,
IScriptClassLoader iscl,
java.util.Locale locale)
Since v2, it must be called before build( ), and should only be called once per design model. |
void |
refresh(GeneratedChartState gcs)
Performs a minimal rebuild of the chart if non-sizing attributes are altered or the dataset for any series has changed. |
void |
render(IDeviceRenderer idr,
GeneratedChartState gcs)
Draws a previously built chart using the specified device renderer into a target output device. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static final Generator instance()
public java.util.List getRowExpressions(Chart cm) throws ChartException
cm
- The Chart model
ChartException
public java.util.List getRowExpressions(Chart cm, IActionEvaluator iae) throws ChartException
cm
- The Chart modeliae
- An IActionEvaluator instance
ChartException
public void bindData(java.sql.ResultSet resultSet, Chart chart, RunTimeContext rtc) throws ChartException
resultSet
- A sql resultset that contains the data. The following methods
of the interface need to be implemented: first(), next(),
getObject(String), close()chart
- The chart model to bind the data tortc
- The runtime context
ChartException
public void bindData(IDataRowExpressionEvaluator expressionEvaluator, Chart chart, RunTimeContext rtc) throws ChartException
expressionEvaluator
- The data row expression evaluator implementationchart
- The chart modelrtc
- The runtime context
ChartException
public void bindData(IDataRowExpressionEvaluator expressionEvaluator, IActionEvaluator iae, Chart chart, RunTimeContext rtc) throws ChartException
expressionEvaluator
- The data row expression evaluator implementationiae
- An IActionEvaluator instance.chart
- The chart modelrtc
- The runtime context
ChartException
public RunTimeContext prepare(Chart model, IExternalContext externalContext, IScriptClassLoader iscl, java.util.Locale locale) throws ChartException
model
- Chart design modelexternalContext
- External Contextlocale
- Locale
ChartException
public final GeneratedChartState build(IDisplayServer ids, Chart cmDesignTime, org.mozilla.javascript.Scriptable scParent, Bounds bo, RunTimeContext rtc) throws ChartException
ids
- A display server using which the chart may be built.cmDesignTime
- The design time chart model (bound to a dataset).scParent
- A parent script handler that may be attached to the existing
chart model script handler.bo
- The bounds associated with the chart being built.rtc
- Encapsulates the runtime environment for the build process.
GenerationException
ChartException
public final GeneratedChartState build(IDisplayServer ids, Chart cmDesignTime, org.mozilla.javascript.Scriptable scParent, Bounds bo, RunTimeContext rtc, IStyleProcessor externalProcessor) throws ChartException
ids
- A display server using which the chart may be built.cmDesignTime
- The design time chart model (bound to a dataset).scParent
- A parent script handler that may be attached to the existing
chart model script handler.bo
- The bounds associated with the chart being built.rtc
- Encapsulates the runtime environment for the build process.externalProcessor
- An external style processor.
GenerationException
ChartException
public final GeneratedChartState build(IDisplayServer ids, Chart cmDesignTime, Bounds bo, IExternalContext externalContext, RunTimeContext rtc, IStyleProcessor externalProcessor) throws ChartException
ids
- A display server using which the chart may be built.cmDesignTime
- The design time chart model (bound to a dataset).externalContext
- An external context object.bo
- The bounds associated with the chart being built.rtc
- Encapsulates the runtime environment for the build process.externalProcessor
- An external style processor. If it's null, an implicit
processor will be used.
GenerationException
ChartException
public final void refresh(GeneratedChartState gcs) throws ChartException
gcs
- A previously built chart encapsulated in a transient
structure.
GenerationException
ChartException
public final void render(IDeviceRenderer idr, GeneratedChartState gcs) throws ChartException
idr
- A device renderer that determines the target context on which
the chart will be rendered.gcs
- A previously built chart that needs to be rendered.
GenerationException
ChartException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |