Package com.jalios.jcms.policy

Class BasicExportPolicyFilter

java.lang.Object

com.jalios.jcms.policy.AbstractPolicyFilter

com.jalios.jcms.policy.BasicExportPolicyFilter

All Implemented Interfaces:

PluginComponent, ExportPolicyFilter, PolicyFilter, java.lang.Comparable

public class BasicExportPolicyFilter
extends AbstractPolicyFilter
implements ExportPolicyFilter, PluginComponent

This class provides hooks for data export.

Since:

jcms-5.7.2

Author:

Olivier Dedieu

Field Summary

Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter

order

Constructor Summary

Constructors

Constructor	Description
BasicExportPolicyFilter()

Method Summary

Modifier and Type	Method	Description
boolean	init(Plugin plugin)	Initialize the component with the given plugin configuration
void	processDataExport(Data data, java.lang.StringBuffer sb, java.util.Map context)	This method is called for each data to export.
void	processDataSetExport(java.util.Set<? extends Data> dataSet, java.lang.StringBuffer sb, java.util.Map context)	This method is called for each data set to export.
void	processDataXmlRelatedExport(Data data, java.lang.StringBuffer sb, java.lang.String related)	This method is called for related field being request for export, for each data to export.

Methods inherited from class com.jalios.jcms.policy.AbstractPolicyFilter

compareTo, equals, getOrder, setOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

BasicExportPolicyFilter

public BasicExportPolicyFilter()

Method Detail

init

public boolean init(Plugin plugin)

Description copied from interface: PluginComponent

Initialize the component with the given plugin configuration

Specified by:

init in interface PluginComponent

Parameters:

plugin - the calling plugin

Returns:

true if the component has been correctly initialized.

Since:

jcms-5.7.1

See Also:

PluginComponent.init(Plugin)

processDataExport

public void processDataExport(Data data,
                              java.lang.StringBuffer sb,
                              java.util.Map context)

Description copied from interface: ExportPolicyFilter

This method is called for each data to export. The StringBuffer sb contains the XML export of the data.

Specified by:

processDataExport in interface ExportPolicyFilter

Parameters:

data - the exported data.

sb - contains the XML representation of the data.

context - the export context.

See Also:

ExportPolicyFilter.processDataExport(Data, java.lang.StringBuffer, java.util.Map)

processDataSetExport

public void processDataSetExport(java.util.Set<? extends Data> dataSet,
                                 java.lang.StringBuffer sb,
                                 java.util.Map context)

Description copied from interface: ExportPolicyFilter

This method is called for each data set to export. The StringBuffer sb contains the XML export of the data set.

Specified by:

processDataSetExport in interface ExportPolicyFilter

Parameters:

dataSet - the data set.

sb - contains the XML representation of the data set.

context - the export context.

See Also:

ExportPolicyFilter.processDataSetExport(Set, java.lang.StringBuffer, java.util.Map)

processDataXmlRelatedExport

public void processDataXmlRelatedExport(Data data,
                                        java.lang.StringBuffer sb,
                                        java.lang.String related)

Description copied from interface: ExportPolicyFilter

This method is called for related field being request for export, for each data to export. The StringBuffer sb contains the XML export of the data, after data field, during related output, and before data closing tag.

Specified by:

processDataXmlRelatedExport in interface ExportPolicyFilter

Parameters:

data - the exported data.

sb - contains the XML representation of the data.

related - name of the related field being requested for export

See Also:

ExportPolicyFilter.processDataXmlRelatedExport(Data, StringBuffer, String)