com.googlecode.wickedcharts.highcharts.jackson.JsonRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicked-charts-highcharts Show documentation
A Java abstraction of the Highcharts javascript library to include interactive charts in your Java web application.
The newest version!
/**
 *   Copyright 2012-2013 Wicked Charts (http://wicked-charts.googlecode.com)
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
package com.googlecode.wickedcharts.highcharts.jackson;

import java.util.Locale;

import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.googlecode.wickedcharts.highcharts.json.LowercaseEnum;
import com.googlecode.wickedcharts.highcharts.options.Center;
import com.googlecode.wickedcharts.highcharts.options.Crosshair;
import com.googlecode.wickedcharts.highcharts.options.CssStyle;
import com.googlecode.wickedcharts.highcharts.options.DateTimeLabelFormat;
import com.googlecode.wickedcharts.highcharts.options.Function;
import com.googlecode.wickedcharts.highcharts.options.MinorTickInterval;
import com.googlecode.wickedcharts.highcharts.options.PixelOrPercent;
import com.googlecode.wickedcharts.highcharts.options.Symbol;
import com.googlecode.wickedcharts.highcharts.options.color.HexColor;
import com.googlecode.wickedcharts.highcharts.options.color.HighchartsColor;
import com.googlecode.wickedcharts.highcharts.options.color.NullColor;
import com.googlecode.wickedcharts.highcharts.options.color.RgbaColor;
import com.googlecode.wickedcharts.highcharts.options.color.SimpleColor;
import com.googlecode.wickedcharts.highcharts.options.series.Bubble;
import com.googlecode.wickedcharts.highcharts.options.series.Coordinate;
import com.googlecode.wickedcharts.highcharts.options.series.RangeCoordinate;

/**
 * A renderer for rendering Highcharts options into JSON objects based on the
 * Jackson Mapping library.
 * 
 * @author Tom Hombergs ([email protected])
 * 
 */
public class JsonRenderer {

	private final ObjectMapper jacksonMapper;

	private final WickedChartsJacksonModule jacksonModule;

	/**
	 * The default mapper can be used to bypass the serializers registered in the
	 * {@link WickedChartsJacksonModule}.
	 */
	public final static ObjectMapper DEFAULT_MAPPER = createDefaultObjectMapper();

	public JsonRenderer() {
		this.jacksonModule = new WickedChartsJacksonModule();
		this.jacksonMapper = createJacksonMapper();
	}

	/**
	 * This method gives the opportunity to add a custom serializer to serializer
	 * one of the highchart option classes. It may be neccessary to serialize
	 * certain option classes differently for different web frameworks.
	 * 
	 * @param clazz
	 *          the option class
	 * @param serializer
	 *          the serializer responsible for serializing objects of the option
	 *          class.
	 */
	public  void addSerializer(final Class clazz, final JsonSerializer serializer) {
		this.jacksonModule.addSerializer(clazz, serializer);
	}

	@SuppressWarnings({ "rawtypes", "unchecked" })
	private ObjectMapper createJacksonMapper() {

		this.jacksonModule.addSerializer(Center.class, new CenterSerializer());
		this.jacksonModule.addSerializer(SimpleColor.class, new SimpleColorReferenceSerializer());
		this.jacksonModule.addSerializer(HighchartsColor.class, new HighchartsColorReferenceSerializer());
		this.jacksonModule.addSerializer(HexColor.class, new HexColorReferenceSerializer());
		this.jacksonModule.addSerializer(LowercaseEnum.class, new LowercaseEnumSerializer());
		this.jacksonModule.addSerializer(PixelOrPercent.class, new PixelOrPercentSerializer());
		this.jacksonModule.addSerializer(Symbol.class, new SymbolSerializer());
		this.jacksonModule.addSerializer(RgbaColor.class, new RgbaColorReferenceSerializer());
		this.jacksonModule.addSerializer(NullColor.class, new NullColorReferenceSerializer());
		this.jacksonModule.addSerializer(MinorTickInterval.class, new MinorTickIntervalSerializer());
		this.jacksonModule.addSerializer(Function.class, new FunctionSerializer());
		this.jacksonModule.addSerializer(CssStyle.class, new CssStyleSerializer());
		this.jacksonModule.addSerializer(DateTimeLabelFormat.class, new DateTimeLabelFormatSerializer());
		this.jacksonModule.addSerializer(Coordinate.class, new CoordinateSerializer());
		this.jacksonModule.addSerializer(Crosshair.class, new CrosshairSerializer());
		this.jacksonModule.addSerializer(RangeCoordinate.class, new RangeCoordinateSerializer());
		this.jacksonModule.addSerializer(Bubble.class, new BubbleSerializer());

		ObjectMapper mapper = createDefaultObjectMapper();
		mapper.setLocale(Locale.ENGLISH);
		mapper.registerModule(this.jacksonModule);
		return mapper;
	}

	private static ObjectMapper createDefaultObjectMapper() {
		ObjectMapper mapper = new ObjectMapper();
		mapper.enable(SerializationFeature.INDENT_OUTPUT);
		mapper.disable(SerializationFeature.WRITE_NULL_MAP_VALUES);
		mapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
		mapper.setSerializationInclusion(Include.NON_NULL);
		return mapper;
	}

	public String toJson(final Object object) {
		try {
			return this.jacksonMapper.writeValueAsString(object);
		} catch (Exception e) {
			throw new RuntimeException("Error trying to serialize object of type " + object.getClass().getName()
			    + " into JSON!", e);
		}
	}

	public  T fromJson(final String json, final Class targetClazz) {
		try {
			return this.jacksonMapper.readValue(json, targetClazz);
		} catch (Exception e) {
			throw new RuntimeException("Error trying to deserialize object of type " + targetClazz.getName() + " into JSON!",
			    e);
		}
	}
}