com.espertech.esper.event.util.EventRendererImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of esper Show documentation
Complex event processing and event series analysis component
There is a newer version: 7.1.0
/*
 ***************************************************************************************
 *  Copyright (C) 2006 EsperTech, Inc. All rights reserved.                            *
 *  http://www.espertech.com/esper                                                     *
 *  http://www.espertech.com                                                           *
 *  ---------------------------------------------------------------------------------- *
 *  The software in this package is published under the terms of the GPL license       *
 *  a copy of which has been included with this distribution in the license.txt file.  *
 ***************************************************************************************
 */
package com.espertech.esper.event.util;

import com.espertech.esper.client.EventBean;
import com.espertech.esper.client.EventType;
import com.espertech.esper.client.util.*;

/**
 * Provider for rendering services of {@link com.espertech.esper.client.EventBean} events.
 */
public class EventRendererImpl implements EventRenderer {
    /**
     * Returns a render for the JSON format, valid only for the given event type and its subtypes.
     *
     * @param eventType to return renderer for
     * @param options   rendering options
     * @return JSON format renderer
     */
    public JSONEventRenderer getJSONRenderer(EventType eventType, JSONRenderingOptions options) {
        return new JSONRendererImpl(eventType, options);
    }

    /**
     * Returns a render for the JSON format, valid only for the given event type and its subtypes.
     *
     * @param eventType to return renderer for
     * @return JSON format renderer
     */
    public JSONEventRenderer getJSONRenderer(EventType eventType) {
        return new JSONRendererImpl(eventType, new JSONRenderingOptions());
    }

    /**
     * Quick-access method to render a given event in the JSON format.
     * 
     * Use the #getJSONRenderer to obtain a renderer instance that allows repeated rendering of the same type of event.
     * For performance reasons obtaining a dedicated renderer instance is the preferred method compared to repeated rendering via this method.
     *
     * @param title    the JSON root title
     * @param theEvent the event to render
     * @return JSON formatted text
     */
    public String renderJSON(String title, EventBean theEvent) {
        return renderJSON(title, theEvent, new JSONRenderingOptions());
    }

    /**
     * Quick-access method to render a given event in the JSON format.
     * 

     * Use the #getJSONRenderer to obtain a renderer instance that allows repeated rendering of the same type of event.
     * For performance reasons obtaining a dedicated renderer instance is the preferred method compared to repeated rendering via this method.
     *
     * @param title    the JSON root title
     * @param theEvent the event to render
     * @param options  are JSON rendering options
     * @return JSON formatted text
     */
    public String renderJSON(String title, EventBean theEvent, JSONRenderingOptions options) {
        if (theEvent == null) {
            return null;
        }
        return getJSONRenderer(theEvent.getEventType(), options).render(title, theEvent);
    }

    /**
     * Returns a render for the XML format, valid only for the given event type and its subtypes.
     *
     * @param eventType to return renderer for
     * @return XML format renderer
     */
    public XMLEventRenderer getXMLRenderer(EventType eventType) {
        return new XMLRendererImpl(eventType, new XMLRenderingOptions());
    }

    /**
     * Returns a render for the XML format, valid only for the given event type and its subtypes.
     *
     * @param eventType to return renderer for
     * @param options   rendering options
     * @return XML format renderer
     */
    public XMLEventRenderer getXMLRenderer(EventType eventType, XMLRenderingOptions options) {
        return new XMLRendererImpl(eventType, options);
    }

    /**
     * Quick-access method to render a given event in the XML format.
     * 

     * Use the #getXMLRenderer to obtain a renderer instance that allows repeated rendering of the same type of event.
     * For performance reasons obtaining a dedicated renderer instance is the preferred method compared to repeated rendering via this method.
     *
     * @param rootElementName the root element name that may also include namespace information
     * @param theEvent        the event to render
     * @return XML formatted text
     */
    public String renderXML(String rootElementName, EventBean theEvent) {
        return renderXML(rootElementName, theEvent, new XMLRenderingOptions());
    }

    /**
     * Quick-access method to render a given event in the XML format.
     * 
     * Use the #getXMLRenderer to obtain a renderer instance that allows repeated rendering of the same type of event.
     * For performance reasons obtaining a dedicated renderer instance is the preferred method compared to repeated rendering via this method.
     *
     * @param rootElementName the root element name that may also include namespace information
     * @param theEvent        the event to render
     * @param options         are XML rendering options
     * @return XML formatted text
     */
    public String renderXML(String rootElementName, EventBean theEvent, XMLRenderingOptions options) {
        if (theEvent == null) {
            return null;
        }
        return getXMLRenderer(theEvent.getEventType(), options).render(rootElementName, theEvent);
    }
}