Package org.ametys.cms.properties.section

Class AbstractDefaultPropertySection

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.properties.section.AbstractPropertySection

org.ametys.cms.properties.section.AbstractDefaultPropertySection

All Implemented Interfaces:

PropertySection, LogEnabled, PluginAware, Prioritizable, Supporter<AmetysObject>, Configurable

Direct Known Subclasses:

AbstractContentReferencerSection, AbstractWebContentReferencerSection, ContentTagsSection, ContentViewSection, FormEntrySubmitSection, PageDetailsSection, PagePublicationSection, PageReferencerSection, PageTagsSection, ProgramItemReferencerSection, ResourceDublinCoreSection, ResourceReferencerSection

public abstract class AbstractDefaultPropertySection
extends AbstractPropertySection

Abstract default class to define a properties section. It use a generic pipeline, the implementation has to define an XSL and the data sent to it.

Constructor Summary

Constructors

Constructor	Description
AbstractDefaultPropertySection()

Method Summary

Modifier and Type	Method	Description
protected String	_getDefaultXSLT()	The default XSL if not defined in the configuration.
protected abstract Map<String,Object>	buildData(AmetysObject ametysObject)	Build the data sent into the request attribute ActionResultGenerator.MAP_REQUEST_ATTR, it will be convert from JSON to XML.
void	configure(Configuration configuration)
String	getDataURL(AmetysObject ametysObject)	Get the pipeline to call to handle and render the section.
Map<String,Object>	getParameters(AmetysObject ametysObject)	Get the parameters to add in the request attributes of the next pipeline.
protected String	getXSLT()	Path to the XSL to render the section.

Methods inherited from class org.ametys.cms.properties.section.AbstractPropertySection

getId, getPriority, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.plugin.component.Supporter

supports

Constructor Details

AbstractDefaultPropertySection

public AbstractDefaultPropertySection()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractPropertySection

Throws:

ConfigurationException

getParameters

public Map<String,Object> getParameters(AmetysObject ametysObject)

Description copied from interface: PropertySection

Get the parameters to add in the request attributes of the next pipeline.

Parameters:

ametysObject - The Ametys object

Returns:

A Map of parameters

getDataURL

public String getDataURL(AmetysObject ametysObject)

Description copied from interface: PropertySection

Get the pipeline to call to handle and render the section.

Parameters:

ametysObject - The Ametys object

Returns:

The path of the pipeline to call

buildData

protected abstract Map<String,Object> buildData(AmetysObject ametysObject)

Build the data sent into the request attribute ActionResultGenerator.MAP_REQUEST_ATTR, it will be convert from JSON to XML.

Parameters:

ametysObject - The resolved object

Returns:

the data

getXSLT

protected String getXSLT()

Path to the XSL to render the section. It is recommended to use the 'view' protocol, with a plugin, like view:myplugin://stylesheets/properties/filename.xsl

Returns:

The XSL path

_getDefaultXSLT

protected String _getDefaultXSLT()

The default XSL if not defined in the configuration. Not mandatory to implement this method but if there is not XSLT configured for the section, the loading will failed.

Returns:

The default XSL path