Package org.opencms.xml.xml2json.document

Class CmsJsonDocumentFolder

java.lang.Object

org.opencms.xml.xml2json.document.A_CmsJsonDocument

org.opencms.xml.xml2json.document.CmsJsonDocumentFolder

All Implemented Interfaces:

I_CmsJsonDocument

public class CmsJsonDocumentFolder
extends A_CmsJsonDocument
implements I_CmsJsonDocument

Class representing a JSON document for a folder.

Field Summary

Fields inherited from class org.opencms.xml.xml2json.document.A_CmsJsonDocument

FIELD_LINKED_CONTENTS, m_context, m_json, m_jsonRequest

Constructor Summary

Constructors

Constructor	Description
CmsJsonDocumentFolder(CmsJsonRequest jsonRequest)	Creates a new JSON document.

Method Summary

Modifier and Type	Method	Description
protected JSONObject	folderListingJson(CmsResource target, int levelsLeft)	Formats folder listing as a JSON object, with the individual file names in the folder as keys.
java.lang.Object	getJson()	Returns the JSON document.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsJsonDocumentFolder

public CmsJsonDocumentFolder(CmsJsonRequest jsonRequest)

Creates a new JSON document.

Parameters:

jsonRequest - the JSON request

Method Detail

getJson

public java.lang.Object getJson()
                         throws JSONException,
                                CmsException,
                                CmsJsonHandlerException,
                                CmsJsonHandlerXmlContent.PathNotFoundException,
                                java.lang.Exception

Description copied from interface: I_CmsJsonDocument

Returns the JSON document.

Specified by:

getJson in interface I_CmsJsonDocument

Returns:

the JSON document

Throws:

JSONException - if rendering the JSON document fails

CmsException - if reading a resource or evaluating a SOLR search fails

CmsJsonHandlerException - if the request is not valid according to the specification

CmsJsonHandlerXmlContent.PathNotFoundException - if the selected path does not exist

java.lang.Exception - if something else goes wrong

See Also:

I_CmsJsonDocument.getJson()

folderListingJson

protected JSONObject folderListingJson(CmsResource target,
                                       int levelsLeft)
                                throws java.lang.Exception

Formats folder listing as a JSON object, with the individual file names in the folder as keys.

Parameters:

target - the folder

levelsLeft - the number of levels to format (if 1, only the direct children are listed)

Returns:

the JSON representation of the folder listing

Throws:

java.lang.Exception - if something goes wrong