Package com.xwiki.admintools

Interface DataProvider

@Role
public interface DataProvider

Gathers specific data and returns it in a specific format, using a template.

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getDataAsJSON()	Provides the info structured in a json.
String	getIdentifier()	Extract the hint of a component.
String	getRenderedData()	Provides the data provider information in a format given by the associated template.

Method Detail

getRenderedData

String getRenderedData()

Provides the data provider information in a format given by the associated template.

Returns:

the information formatted by the associated template as a String.

getIdentifier

String getIdentifier()

Extract the hint of a component.

Returns:

the component hint.

getDataAsJSON

Map<String,String> getDataAsJSON()
                                throws Exception

Provides the info structured in a json.

Returns:

a Map with the generated info.

Throws:

Exception - if there are any errors while gathering the needed data.