Package org.opencms.xml.xml2json.renderer

Interface I_CmsJsonRendererXmlContent

All Superinterfaces:

I_CmsConfigurationParameterHandler

All Known Implementing Classes:

CmsJsonRendererXmlContent

public interface I_CmsJsonRendererXmlContent
extends I_CmsConfigurationParameterHandler

Renders a single-locale content tree as JSON.

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Method Summary

Modifier and Type	Method	Description
void	initialize(CmsObject cms)	Initializes the context for the renderer.
void	initialize(CmsJsonHandlerContext context)	Initializes the context for the renderer.
Object	render(CmsXmlContent content, Locale locale)	Converts the XML content for a single locale to a JSON object

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Method Details

initialize

void initialize(CmsJsonHandlerContext context)
         throws CmsException

Initializes the context for the renderer.

Parameters:

context - the context to set

Throws:

CmsException - if something goes wrong

initialize

void initialize(CmsObject cms)
         throws CmsException

Initializes the context for the renderer.

Parameters:

cms - the CMS object to set

Throws:

CmsException - if something goes wrong

render

Object render(CmsXmlContent content,
 Locale locale)
       throws JSONException

Converts the XML content for a single locale to a JSON object

Parameters:

content - the content

locale - the locale

Returns:

the JSON object

Throws:

JSONException - if something goes wrong