Package org.ametys.web.tags.inputdata

Class FilteredContentsInputData

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.tags.inputdata.FilteredContentsInputData

All Implemented Interfaces:

FileReloader, PluginAware, InputData, Initializable, Contextualizable, LogEnabled, Serviceable, ThreadSafe

public class FilteredContentsInputData
extends AbstractLogEnabled
implements InputData, Serviceable, Contextualizable, ThreadSafe, PluginAware, FileReloader, Initializable

This class generates an output with all existing filters defined on context's current page.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeEP	The extension point for content types
protected Context	_context	The avalon context.
protected String	_pluginName	The plugin name
protected AmetysObjectResolver	_resolver	The repository
protected SiteManager	_siteManager	The site manager
protected SourceResolver	_sourceResolver	The source resolver
protected TagProviderExtensionPoint	_tagProviderEP	The tag provider EP

Constructor Summary

Constructors

Constructor	Description
FilteredContentsInputData()

Method Summary

Modifier and Type	Method	Description
protected List<WebContentFilter>	configureFilters(Site site, Page page)	Retrieves the configured filters
void	contextualize(Context context)
String	getId(String sourceUrl)	Get an unique ID for this File Reloader
void	initialize()
boolean	isCacheable(Site site, Page page)	Returns true if this InputData is cacheable for the current site and if possible page.
protected void	saxFilter(ContentHandler contentHandler, WebContentFilter filter, String siteName, String lang, Page page)	SAX a filter
void	service(ServiceManager smanager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
void	toSAX(ContentHandler contentHandler)	Generates SAX events for providing data.
void	updateFile(String sourceUrl, Source source, InputStream is)	Update the file, the sourceUrl is only there if you manage multiple files, the Configuration object is already present to read it

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.web.inputdata.InputData

shouldBeCached

Field Details

_pluginName

protected String _pluginName

The plugin name

_sourceResolver

protected SourceResolver _sourceResolver

The source resolver

_resolver

protected AmetysObjectResolver _resolver

The repository

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

The extension point for content types

_context

protected Context _context

The avalon context.

_siteManager

protected SiteManager _siteManager

The site manager

_tagProviderEP

protected TagProviderExtensionPoint _tagProviderEP

The tag provider EP

Constructor Details

FilteredContentsInputData

public FilteredContentsInputData()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

isCacheable

public boolean isCacheable(Site site,
 Page page)

Description copied from interface: InputData

Returns true if this InputData is cacheable for the current site and if possible page.

Specified by:

isCacheable in interface InputData

Parameters:

site - the current Site.

page - the current Page. Can be null.

Returns:

true if this InputData is cacheable for the current site or page.

toSAX

public void toSAX(ContentHandler contentHandler)
           throws SAXException,
ProcessingException

Description copied from interface: InputData

Generates SAX events for providing data.

Specified by:

toSAX in interface InputData

Parameters:

contentHandler - the content handler to SAX into.

Throws:

SAXException - if an error occurs while SAXing.

ProcessingException - if an error occurs during processing.

configureFilters

protected List<WebContentFilter> configureFilters(Site site,
 Page page)
                                           throws Exception

Retrieves the configured filters

Parameters:

site - the current Site

page - the current Page

Returns:

The list of filters

Throws:

Exception - If an error occurred while parsing the file.

saxFilter

protected void saxFilter(ContentHandler contentHandler,
 WebContentFilter filter,
 String siteName,
 String lang,
 Page page)
                  throws SAXException,
IOException

SAX a filter

Parameters:

contentHandler - The content handler

filter - The filter to SAX

siteName - The current site name

lang - The current language

page - The current page

Throws:

SAXException - If an errors occurs while SAXing

IOException - If an errors occurs

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getId

public String getId(String sourceUrl)

Description copied from interface: FileReloader

Get an unique ID for this File Reloader

Specified by:

getId in interface FileReloader

Parameters:

sourceUrl - this is passed as an argument if your class read multiple files. If it reads only one file, the full class name can be a good enough ID

Returns:

an unique ID

updateFile

public void updateFile(String sourceUrl,
 Source source,
 InputStream is)
                throws Exception

Description copied from interface: FileReloader

Update the file, the sourceUrl is only there if you manage multiple files, the Configuration object is already present to read it

Specified by:

updateFile in interface FileReloader

Parameters:

sourceUrl - the url of the file.

source - the source to read, can be null if no file was read

is - the input stream to read, can be null if no file was read

Throws:

Exception - something went wrong while reading the inputstream