WEB4J Development Tools 4.10.0.0

hirondelle.web4jtools.metrics.base
Class MetricsAction

Object
  extended by ActionImpl
      extended by hirondelle.web4jtools.metrics.base.MetricsAction
All Implemented Interfaces:
Action
Direct Known Subclasses:
CommentsAction, FilesAction, HistogramAction, ImageReferencesAction, JarsAction, LinesAction, TabsListAction, TabsRemoveAction, TestsAction

public abstract class MetricsAction
extends ActionImpl

Abstract Base Class for most Actions related to metrics.

Confirms that a scan of the base directory has been performed. If not, then the user is advised to use the Summary page first.


Field Summary
protected  List<FileInfo> fFileList
          If this List<FileInfo> is not in session scope, then an error message is presented to the user.
 
Fields inherited from class ActionImpl
DATA, ERRORS, ITEM_FOR_EDIT, ITEMS_FOR_LISTING, MESSAGES, USER_ID
 
Constructor Summary
MetricsAction(ResponsePage aResponsePage, RequestParser aRequestParser)
          Full constructor.
 
Method Summary
protected abstract  void calculateMetric()
          Abstract method implemented by subclasses, and called by execute().
 ResponsePage execute()
          Template method.
 
Methods inherited from class ActionImpl
addError, addError, addError, addMessage, addMessage, addToRequest, addToSession, copyFromSessionToRequest, createSessionAndCsrfToken, endSession, getErrors, getExistingSession, getFromSession, getIdParam, getIdParams, getLocale, getLoggedInUserName, getMessages, getOperation, getOrderBy, getParam, getParamUnsafe, getRequestParser, getResponsePage, getTimeZone, getUserId, hasErrors, removeFromSession, setResponsePage
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fFileList

protected List<FileInfo> fFileList
If this List<FileInfo> is not in session scope, then an error message is presented to the user. This is is basic data structure used for source code statistics. It represents data that is read in when the user 'scans the source code', using the Summary page.

Constructor Detail

MetricsAction

public MetricsAction(ResponsePage aResponsePage,
                     RequestParser aRequestParser)
Full constructor.

Method Detail

execute

public ResponsePage execute()
                     throws AppException
Template method. If the fFileList is present in session scope as expected, then calculateMetric() is called; otherwise, an error message is presented to the user.

Specified by:
execute in interface Action
Specified by:
execute in class ActionImpl
Throws:
AppException

calculateMetric

protected abstract void calculateMetric()
Abstract method implemented by subclasses, and called by execute().


WEB4J Development Tools 4.10.0.0

Copyright Hirondelle Systems - Generated 2013Oct19.12.26