|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.chart.util.PluginSettings
public final class PluginSettings
Provides a framework for locating extension implementations either via the BIRT plugin.xml paradigm or via extensions that are explicitly specified in this singleton instance. If the BIRT extension paradigm is to be used, ensure that the BIRT_HOME 'JVM system variable' points to a valid folder containing all chart extensions within a plugins/ subfolder. If the BIRT extension paradigm is not to be used and the default classloader is requested for loading extensions, ensure that the BIRT_HOME 'JVM system variable' is undefined.
Nested Class Summary | |
---|---|
static class |
PluginSettings.DefaultAggregations
All available default aggregation names. |
Method Summary | |
---|---|
IAggregateFunction |
getAggregateFunction(java.lang.String sName)
Retrieves the first instance of a device renderer registered as an extension for a given name |
IDataPointDefinition |
getDataPointDefinition(java.lang.Class cSeries)
Retrieves the first instance of a series renderer registered as an extension for a given series type. |
IDataSetProcessor |
getDataSetProcessor(java.lang.Class cSeries)
Retrieves the first instance of a data set processor registered as an extension for a given series type. |
IDeviceRenderer |
getDevice(java.lang.String sName)
Retrieves the first instance of a device renderer registered as an extension for a given name |
IDisplayServer |
getDisplayServer(java.lang.String sName)
Retrieves the first instance of a display server registered as an extension for a given name |
java.lang.String[] |
getRegisteredAggregateFunctionDisplayNames()
Returns a list of all aggregate function display names registered via extension point implementations (or simulated) |
java.lang.String[] |
getRegisteredAggregateFunctionDisplayNames(int aggregateType)
Returns Summary or Running aggregates display name. |
java.lang.String[] |
getRegisteredAggregateFunctions()
Returns a list of all aggregate function names registered via extension point implementations (or simulated) |
java.lang.String[] |
getRegisteredAggregateFunctions(int aggregateType)
Returns Summary or Running aggregates name. |
java.lang.String[][] |
getRegisteredOutputFormats()
Returns a list of registered device renderer output formats and descriptions. |
java.lang.String[] |
getRegisteredSeries()
Returns a list of all series registered via extension point implementations (or simulated) |
BaseRenderer |
getRenderer(java.lang.Class cSeries)
Retrieves the first instance of a series renderer registered as an extension for a given series type. |
java.lang.String |
getSeriesDisplayName(java.lang.String seriesClassName)
Returns the localized display name of given Series Class. |
boolean |
inEclipseEnv()
Performs an internal check to test if the environment uses the extension loading framework or hardcoded classes as defined |
static PluginSettings |
instance()
Returns a singleton instance of the plugin settings framework which uses the default configuration. |
static PluginSettings |
instance(org.eclipse.birt.core.framework.PlatformConfig config)
Returns a singleton instance of the plugin settings framework with specific configuration. |
void |
registerAggregateFunction(java.lang.String sName,
java.lang.String sAggregateFunctionClass)
Registers an aggregate function implementation, the class should implement the IAggregateFunction interface. |
void |
registerAggregateFunction(java.lang.String sName,
java.lang.String sDisplayName,
java.lang.String sAggregateFunctionClass)
Registers an aggregate function implementation, the class should implement the IAggregateFunction interface. |
void |
registerDevice(java.lang.String sName,
java.lang.String sDeviceClass)
Registers a device renderer implementation, this class should implement the IDeviceRenderer interface. |
void |
registerDisplayServer(java.lang.String sName,
java.lang.String sServerClass)
Registers a display server implementation, this class should implement the IDisplayServer interface. |
void |
registerOutputFormat(java.lang.String sDeviceName,
java.lang.String sFormat,
java.lang.String sDescription)
Registers an output format for given device renderer name. |
void |
registerSeriesRenderer(java.lang.String sSeriesClass,
java.lang.String sDataSetProcessorClass,
java.lang.String sRendererClass)
Registers a new Series renderer implementation. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static PluginSettings instance()
public static PluginSettings instance(org.eclipse.birt.core.framework.PlatformConfig config)
public final IDataSetProcessor getDataSetProcessor(java.lang.Class cSeries) throws ChartException
cSeries
- The Class instance associated with the given series type
PluginException
ChartException
public final BaseRenderer getRenderer(java.lang.Class cSeries) throws ChartException
cSeries
- The Class instance associated with the given series type
PluginException
ChartException
public final IDeviceRenderer getDevice(java.lang.String sName) throws ChartException
sName
- The name of the device renderer. Values registered in the
default distribution are dv.SWT, dv.SWING, dv.PNG, dv.JPEG,
dv.BMP
PluginException
ChartException
public final IDisplayServer getDisplayServer(java.lang.String sName) throws ChartException
sName
- The name of the display server. Values registered in the
default distribution are ds.SWT, ds.SWING
PluginException
ChartException
public final IAggregateFunction getAggregateFunction(java.lang.String sName) throws ChartException
sName
- The name of the aggregate function.
PluginException
ChartException
public final IDataPointDefinition getDataPointDefinition(java.lang.Class cSeries) throws ChartException
cSeries
- The Class instance associated with the given series type
PluginException
ChartException
public final java.lang.String getSeriesDisplayName(java.lang.String seriesClassName)
seriesClassName
-
public final java.lang.String[] getRegisteredSeries() throws ChartException
ChartException
public final java.lang.String[][] getRegisteredOutputFormats() throws ChartException
ChartException
public final java.lang.String[] getRegisteredAggregateFunctions() throws ChartException
ChartException
public final java.lang.String[] getRegisteredAggregateFunctions(int aggregateType) throws ChartException
aggregateType
-
ChartException
public final java.lang.String[] getRegisteredAggregateFunctionDisplayNames() throws ChartException
ChartException
public final java.lang.String[] getRegisteredAggregateFunctionDisplayNames(int aggregateType) throws ChartException
aggregateType
-
ChartException
public boolean inEclipseEnv()
public final void registerAggregateFunction(java.lang.String sName, java.lang.String sAggregateFunctionClass)
sName
- sAggregateFunctionClass
- the full qualified class name of the implementor.IAggregateFunction
public final void registerAggregateFunction(java.lang.String sName, java.lang.String sDisplayName, java.lang.String sAggregateFunctionClass)
sName
- sDisplayName
- sAggregateFunctionClass
- the full qualified class name of the implementor.IAggregateFunction
public final void registerDevice(java.lang.String sName, java.lang.String sDeviceClass)
sName
- sDeviceClass
- the full qualified class name of the implementor.IDeviceRenderer
public final void registerOutputFormat(java.lang.String sDeviceName, java.lang.String sFormat, java.lang.String sDescription)
sDeviceName
- sFormat
- sDescription
- public final void registerDisplayServer(java.lang.String sName, java.lang.String sServerClass)
sName
- sServerClass
- the full qualified class name of the implementor.IDisplayServer
public final void registerSeriesRenderer(java.lang.String sSeriesClass, java.lang.String sDataSetProcessorClass, java.lang.String sRendererClass)
sSeriesClass
- the full qualified class name of which implements the Series
interface.sDataSetProcessorClass
- the full qualified class name of which implements the
IDataSetProcessor interface.sRendererClass
- the full qualified class name of which implements the
ISeriesRenderer interface.ISeriesRenderer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |