com.jalios.jcms.policy
Interface StatPolicyFilter

All Superinterfaces:
Comparable, PluginComponent, PolicyFilter
All Known Implementing Classes:
BasicStatPolicyFilter

public interface StatPolicyFilter
extends PolicyFilter

This class is a hook to allow developer to add custom stat behaviour without implementing many StatListener

Since:
jcms-5.5.0
Version:
$Revision: 18706 $
Author:
Jean-Philippe Encausse

Field Summary
 
Fields inherited from interface com.jalios.jcms.plugin.PluginComponent
REVISION
 
Method Summary
 boolean checkAfterValidateEntry(AbstractStatFieldListener listener, StatEntry entry, boolean jcms)
          This method is a Hook for handleStatEntry() method of AbstractStatFieldListener.
 boolean checkBeforeValidateEntry(AbstractStatFieldListener listener, StatEntry entry, boolean jcms)
          This method is a Hook for handleStatEntry() method of AbstractStatFieldListener.
 StatListener checkCreateStatListener(PortletStat portlet, PortalElement report, StatListener listener)
          This method is a Hook for createStatListener() method of StatManager.
 void checkEndOfStatEntries(AbstractStatFieldListener listener, Map workspaceMap)
          This method is a Hook for handleEndOfStatEntries() method of AbstractStatFieldListener.
 void checkGeneratedReports(Map jspMap, StatReport report, Member member)
          This method is a Hook for method StaManager.render().
 void checkProcessEntry(Map workspaceMap, AbstractStatFieldListener listener, StatEntry entry, Object workspace)
          This method is a Hook for handleStatEntry() method of AbstractStatFieldListener.
 StatListener createStatListener(PortletStat portlet, PortalElement report, StatListener listener)
          This method is a Hook to createStatListener() method of StatManager.
 void initListener(AbstractStatListener listener)
          This method is a Hook for init() method of AbstractStatListener.
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface com.jalios.jcms.plugin.PluginComponent
init
 

Method Detail

initListener

void initListener(AbstractStatListener listener)
This method is a Hook for init() method of AbstractStatListener. It allow changes of Listener behavior. It is called at the end of init() method.

Parameters:
listener - an AbstractStatListener

checkEndOfStatEntries

void checkEndOfStatEntries(AbstractStatFieldListener listener,
                           Map workspaceMap)
This method is a Hook for handleEndOfStatEntries() method of AbstractStatFieldListener. It allow changes of workspaceMap. It is called at the end of handleEndOfStatEntries() method. Usage: - Summarize or compute results at the end of the analyse

Parameters:
listener - an AbstractStatListener
workspaceMap - the workspaceMap

checkBeforeValidateEntry

boolean checkBeforeValidateEntry(AbstractStatFieldListener listener,
                                 StatEntry entry,
                                 boolean jcms)
This method is a Hook for handleStatEntry() method of AbstractStatFieldListener. It validate StatEntry before JCMS (used for performance issues)

Parameters:
listener - an AbstractStatListener
entry - the StatEntry
jcms - the value calculated by jcms
Returns:
boolean true to validate Entry

checkAfterValidateEntry

boolean checkAfterValidateEntry(AbstractStatFieldListener listener,
                                StatEntry entry,
                                boolean jcms)
This method is a Hook for handleStatEntry() method of AbstractStatFieldListener. It validate StatEntry after JCMS

Parameters:
listener - an AbstractStatListener
entry - the StatEntry
jcms - the value calculated by jcms
Returns:
boolean true to validate Entry

checkProcessEntry

void checkProcessEntry(Map workspaceMap,
                       AbstractStatFieldListener listener,
                       StatEntry entry,
                       Object workspace)
This method is a Hook for handleStatEntry() method of AbstractStatFieldListener. It process more information for the given StatEntry. It is called after call of processEntry(), It is called twice: for the decoded workspace and ALL_WORKSPACE

Parameters:
listener - an AbstractStatListener
entry - the StatEntry
workspaceMap - the workspaceMap
workspace - the workspace

checkGeneratedReports

void checkGeneratedReports(Map jspMap,
                           StatReport report,
                           Member member)
This method is a Hook for method StaManager.render(). It allow generation of multiple report for a given analyse. The jspMap contains all templates to render. The key of the map will be set in session attribute and in prefix of generated html file.

Parameters:
report - the StatReport
member - the working member
jspMap - the Map of templates

createStatListener

StatListener createStatListener(PortletStat portlet,
                                PortalElement report,
                                StatListener listener)
This method is a Hook to createStatListener() method of StatManager. It allow creation of a custom StatListener before JCMS

Parameters:
portlet - a PortletStat
report - the PortalElement
listener - the proposed listener or null
Returns:
StatListener the new listener or null

checkCreateStatListener

StatListener checkCreateStatListener(PortletStat portlet,
                                     PortalElement report,
                                     StatListener listener)
This method is a Hook for createStatListener() method of StatManager. It allow overriding of a the StatListener after it's creation

Parameters:
portlet - a PortletStat
report - the PortalElement
listener - the created listener
Returns:
StatListener the statlistener to use or listener


Copyright © 2001-2007 Jalios SA. All Rights Reserved.