Package com.jalios.jcms.policy

Interface ExportPolicyFilter

All Superinterfaces:

java.lang.Comparable, PluginComponent, PolicyFilter

All Known Implementing Classes:

BasicExportPolicyFilter

public interface ExportPolicyFilter
extends PolicyFilter

This interface provides hooks for data export.

Since:

jcms-5.7.2

Version:

$Revision: 74117 $

Author:

Olivier Dedieu

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	REVISION

Method Summary

Modifier and Type	Method	Description
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 interface java.lang.Comparable

compareTo

Methods inherited from interface com.jalios.jcms.plugin.PluginComponent

init

Field Detail

REVISION

static final java.lang.String REVISION

See Also:

Constant Field Values

Method Detail

processDataExport

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

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

Parameters:

data - the exported data.

sb - contains the XML representation of the data.

context - the export context.

Since:

jcms-6.0.0

processDataSetExport

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. The StringBuffer sb contains the XML export of the data set.

Parameters:

dataSet - the data set.

sb - contains the XML representation of the data set.

context - the export context.

Since:

jcms-6.0.0

processDataXmlRelatedExport

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. The StringBuffer sb contains the XML export of the data, after data field, during related output, and before data closing tag.

Parameters:

data - the exported data.

sb - contains the XML representation of the data.

related - name of the related field being requested for export

Since:

jcms-9.0.0