Package com.storedobject.chart

Interface ComponentPart

All Superinterfaces:

ComponentProperty

All Known Subinterfaces:

AbstractDataProvider<T>, CategoryDataProvider, Component, DataProvider, DateDataProvider, InternalData<T>, SankeyDataProvider, TimeDataProvider, TreeDataProvider

All Known Implementing Classes:

AbstractChart, AbstractData, AbstractDataStream, AbstractDataZoom, AbstractPart, AngleAxis, Arc, ArcPart, Area, Axis, Axis.AbstractTicks, Axis.GridAreas, Axis.GridLines, Axis.Line, Axis.MinorGridLines, Axis.MinorTicks, Axis.Pointer, Axis.PointerHandle, Axis.Ticks, BarChart, BasicDataProvider, BasicInternalDataProvider, BezierCurve, BoxplotChart, BoxplotData, BubbleChart, CandlestickChart, CandlestickData, CategoryData, Chart, ChartImage, Circle, CirclePart, ComposedPart, CoordinateSystem, CoordinateSystemZoom, Data, DataStream, DataZoom, DateData, DateStream, DonutChart, EffectScatterChart, FunctionData, FunnelChart, GaugeChart, GaugeChart.AxisLine, GraphChart, GraphData.Node, GraphData.ValueNode, GraphData.XYNode, HeatmapChart, Image, InternalData.WrappedDataProvider, Legend, Line, LineChart, NightingaleRoseChart, PieChart, PolarCoordinate, Polygon, Polyline, RadarAxis, RadarChart, RadarCoordinate, RadiusAxis, Rectangle, RectangularCoordinate, Ring, SankeyChart, SankeyData, SankeyData.Edge, SankeyData.Node, ScatterChart, Sector, SelfPositioningChart, SelfPositioningSpecialChart, SerialData, SerialDate, SerialTime, Shape, ShapeGroup, Square, SunburstChart, Text, TimeData, TimeStream, Title, Toolbox, Toolbox.DataView, Toolbox.Download, Toolbox.Restore, Toolbox.Zoom, ToolboxButton, Tooltip, TreeChart, TreeData, TreemapChart, VisiblePart, VisualMap, XAxis, XYAxis, XYChart, XYDataChart, XYGraphChart, YAxis

public interface ComponentPart
extends ComponentProperty

Represents a part used by chart Components.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
static void	addComma(StringBuilder sb)	Helper method: Add a comma if required.
default String	className()	Helper method to return the class name of the component/part in a more human-friendly way.
static String	className(Class<?> anyClass)	Helper method to return the class name of a given class in a more human-friendly way.
static void	encode(StringBuilder sb, String name, Object value)	Helper method: Encode a (name, value) pair.
static void	encodeFunction(StringBuilder sb, String name, String body, String... params)	Helper method: Encode a generic function
static String	encodeFunction(String body, String... params)	Helper method: Encode a generic function as a string.
static String	escape(Object any)	Helper method to escape invalid characters in JSON strings.
long	getId()	Each part should have a unique Id.
default String	getName()	Get the name of this part.
default int	getRenderingIndex()	Return the rendering index of this part.
int	getSerial()	Get the current serial number (Serial number used for internal purposes only).
static void	removeComma(StringBuilder sb)	Helper method: Replace trailing commas with spaces.
default void	setName(String name)	Set a name for this part.
default void	setRenderingIndex(int index)	Set the rendering index of this part.
void	setSerial(int serial)	Set a serial number (Serial number used for internal purposes only).
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from interface com.storedobject.chart.ComponentProperty

encodeJSON

Method Details

setRenderingIndex

default void setRenderingIndex(int index)

Set the rendering index of this part. Rendering index is the position of this part on the chart when it is being rendered. It is up to the part to keep this value if required.

Parameters:

index - Rendering index.

getRenderingIndex

default int getRenderingIndex()

Return the rendering index of this part. The default implementation returns -1.

Returns:

Rendering index.

getId

long getId()

Each part should have a unique Id. (It can be a final variable and can be set by calling ID.newID().

Returns:

Unique Id.

setSerial

void setSerial(int serial)

Set a serial number (Serial number used for internal purposes only). The implementation of this method must be in such a way that the serial number set here must be returned by the getSerial() method.

Parameters:

serial - Serial number to set.

getSerial

int getSerial()

Get the current serial number (Serial number used for internal purposes only). The serial number set by the setSerial(int) method should be returned by this method.

Returns:

Current serial number.

encode

static void encode(StringBuilder sb,
 String name,
 Object value)

Helper method: Encode a (name, value) pair.

Parameters:

sb - Encoded JSON string to be appended to this.

name - Name to be encoded.

value - Value to be encoded.

addComma

static void addComma(StringBuilder sb)

Helper method: Add a comma if required.

Parameters:

sb - Add a comma to this.

encodeFunction

static void encodeFunction(StringBuilder sb,
 String name,
 String body,
 String... params)

Helper method: Encode a generic function

Parameters:

sb - Encoded JSON string to be appended to this.

name - Name to be encoded (if null, name-part will not be encoded)

body - Body of the function.

params - Parameters of the function.

encodeFunction

static String encodeFunction(String body,
 String... params)

Helper method: Encode a generic function as a string.

Parameters:

body - Body of the function.

params - Parameters.

Returns:

Encoded value.

removeComma

static void removeComma(StringBuilder sb)

Helper method: Replace trailing commas with spaces.

Parameters:

sb - Replace trailing commas in this.

validate

void validate()
       throws ChartException

This method is invoked by SOChart to check if the component or part is valid or not.

Throws:

ChartException - Raises exception if the component or part is not valid.

className

default String className()

Helper method to return the class name of the component/part in a more human-friendly way.

Returns:

Name of the class that can be used for showing a message to the end users.

getName

default String getName()

Get the name of this part.

Returns:

Name

setName

default void setName(String name)

Set a name for this part.

Parameters:

name - Name to set.

className

static String className(Class<?> anyClass)

Helper method to return the class name of a given class in a more human-friendly way.

Parameters:

anyClass - Any class.

Returns:

Name of the class that can be used for showing a message to the end users.

escape

static String escape(Object any)

Helper method to escape invalid characters in JSON strings. Please note that this method returns a double-quoted string unless the parameter is a number. For example, escape("Hello") will return "Hello" not Hello.

Parameters:

any - Anything to encode.

Returns:

Encoded string.