Package org.opencms.xml.xml2json.renderer

Class CmsJsonRendererContainerPage

java.lang.Object

org.opencms.xml.xml2json.renderer.CmsJsonRendererContainerPage

public class CmsJsonRendererContainerPage
extends Object

Used for rendering container pages as a JSON structure.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CmsJsonRendererContainerPage.ContainerNode	Tree node wrapper for a container.
class	CmsJsonRendererContainerPage.ElementNode	Tree node wrapper around a container element.

Constructor Summary

Constructors

Constructor	Description
CmsJsonRendererContainerPage(CmsObject cms, CmsResource page, Predicate<String> propertyFilter)	Creates a new renderer instance.

Method Summary

Modifier and Type	Method	Description
CmsJsonRendererContainerPage.ElementNode	buildTree(CmsContainerPageBean page, String rootPath)	Builds a tree from the given container page bean.
Object	renderJson()	Renders the JSON for the container page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsJsonRendererContainerPage

public CmsJsonRendererContainerPage(CmsObject cms,
 CmsResource page,
 Predicate<String> propertyFilter)

Creates a new renderer instance.

Parameters:

cms - the CMS context

page - the container page to render

propertyFilter - the property filter

Method Details

buildTree

public CmsJsonRendererContainerPage.ElementNode buildTree(CmsContainerPageBean page,
 String rootPath)

Builds a tree from the given container page bean.

The returned tree consists of container nodes (which have children corresponding the container elements) and element nodes (which have children corresponding to the nested containers of the element). The root of the tree is a dummy element node which does not correspond to any element in the page, but just acts as a container for the top-level containers of the page.

Parameters:

page - the container page bean

rootPath - the root path of the container page

Returns:

the dummy root element node

renderJson

public Object renderJson()
                  throws Exception

Renders the JSON for the container page.

Returns:

the JSON for the container page

Throws:

Exception - if something goes wrong