A C F G I L M P R S T U

A

AbstractAnalyzer - class ca.macewan.lmsreporter.api.AbstractAnalyzer.

Convenience class that implements the Analyzer interface.

AbstractAnalyzer() - Constructor for class ca.macewan.lmsreporter.api.AbstractAnalyzer

Constructor, which should always run.

AnalysisEvent - class ca.macewan.lmsreporter.api.AnalysisEvent.

The event type sent by Analyzer objects to AnalysisListener objects.

AnalysisEvent(Analyzer) - Constructor for class ca.macewan.lmsreporter.api.AnalysisEvent

The event constructor.

AnalysisException - exception ca.macewan.lmsreporter.api.AnalysisException.

The class to report analysis-specific errors.

AnalysisException() - Constructor for class ca.macewan.lmsreporter.api.AnalysisException

Constructor.

AnalysisException(String) - Constructor for class ca.macewan.lmsreporter.api.AnalysisException

Constructor.

AnalysisException(String, Throwable) - Constructor for class ca.macewan.lmsreporter.api.AnalysisException

Constructor.

AnalysisException(Throwable) - Constructor for class ca.macewan.lmsreporter.api.AnalysisException

Constructor.

AnalysisListener - interface ca.macewan.lmsreporter.api.AnalysisListener.

Classes that want to be notified by an Analyzer object of the status of the analysis should implement this interface.

Analyzer - interface ca.macewan.lmsreporter.api.Analyzer.

This is the interface every Analyzer class has to implement.

actionPerformed(ActionEvent) - Method in class ca.macewan.lmsreporter.LMSReporter

Called by internal UI elements.

addAnalysisListener(AnalysisListener) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Adds an AnalysisListener to the list of listeners.

addAnalysisListener(AnalysisListener) - Method in interface ca.macewan.lmsreporter.api.Analyzer

The Analyzer object needs to keep a list of AnalysisListeners and notify them of analysis start, progress, finish and errors.

ae - Variable in class ca.macewan.lmsreporter.api.AbstractAnalyzer

The event object used (and re-used) for sending events.

analysisUpdate(AnalysisEvent) - Method in interface ca.macewan.lmsreporter.api.AnalysisListener

Delivers an analysis update event to the listener object.

analyze() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

The method called by the application to start the analysis process.

analyze() - Method in interface ca.macewan.lmsreporter.api.Analyzer

The method called by the application to start the analysis process.

C

ca.macewan.lmsreporter - package ca.macewan.lmsreporter

The LMS Reporter package contains the main application class for the LMS Reporter application.

ca.macewan.lmsreporter.api - package ca.macewan.lmsreporter.api

The LMS Reporter API package provides a simple API for creating your own analysis classes to be hosted by the LMS Reporter application.

F

finishAnalysis(String) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Convenience method to notify the application that your analysis is done.

fireAnalysisUpdate() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Sends the AnalysisEvent ae to all registered AnalysisListeners.

G

getAnalyzer() - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Returns the source of the event as an Analyzer object.

getComponent() - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Gets the component to be displayed.

getCopyright() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Returns a short copyright information string for your Analyzer.

getCopyright() - Method in interface ca.macewan.lmsreporter.api.Analyzer

If this method returns anything, it will be included in the application's user interface for this Analyzer's settings.

getDescription() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

The application will read a description for this Analyzer object which will be used in the analyzer selection list.

getDescription() - Method in interface ca.macewan.lmsreporter.api.Analyzer

The application will read a description for this Analyzer object which will be used in the analyzer selection list.

getError() - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Gets the error that occurred in the analysis.

getGlobalDBFile() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Returns the WebCT^™ comma-separated Global Database file to process.

getGlobalDBKeys() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Utility method to read the first significant line of the global database file and return the database field names as a List.

getInfo() - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Gets an information message to be displayed to the user in conjunction with this event.

getOutputFile() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Returns the output file to save the analysis results in.

getPreferences() - Static method in class ca.macewan.lmsreporter.LMSReporter

Allows access to the application preferences object.

getProgress() - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Gets the level of progress for the analysis.

getSettingsUI() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Called when the implementing class is selected by the user.

getSettingsUI() - Method in interface ca.macewan.lmsreporter.api.Analyzer

Called when the implementing class is selected by the user.

getSnapshotFile() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Returns the WebCT^™ IMS Enterprise XML snapshot file to process.

getType() - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Gets the type of this event.

I

isRunning() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Returns true if the analysis is currently running.

isRunning() - Method in interface ca.macewan.lmsreporter.api.Analyzer

Returns true if the analysis is currently running.

isWaitingForUI() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Returns true if the analysis is currently suspended, waiting for some user interface action to complete.

isWaitingForUI() - Method in interface ca.macewan.lmsreporter.api.Analyzer

Returns true if the analysis is currently suspended, waiting for some user interface action to complete.

L

LMSReporter - class ca.macewan.lmsreporter.LMSReporter.

This is the main application class.

M

main(String[]) - Static method in class ca.macewan.lmsreporter.LMSReporter

The main method is called by the JVM to start the application.

P

PROGRESS_MAX - Static variable in class ca.macewan.lmsreporter.api.AnalysisEvent

The maximum value of analysis progress.

PROGRESS_MIN - Static variable in class ca.macewan.lmsreporter.api.AnalysisEvent

The minimum value of analysis progress.

postProcess() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Called immediately after the analyze method.

postProcess() - Method in interface ca.macewan.lmsreporter.api.Analyzer

Called immediately after the analyze method.

preProcess() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Called immediately before the analyze method.

preProcess() - Method in interface ca.macewan.lmsreporter.api.Analyzer

Called immediately before the analyze method.

R

readGlobalDB() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Utility method to read the whole global database CSV file into a HashMap.

readGlobalDBField(String) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Reads the global database file, and creates a HashMap where the keys are each user's WebCT ID, and the values are the value of the requested field as strings.

readGlobalDBField(String, double, double) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Creates a HashMap with the values of the requested field (see readGlobalDBField(String) for more information).

removeAnalysisListener(AnalysisListener) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Removes an AnalysisListener from the list of listeners.

removeAnalysisListener(AnalysisListener) - Method in interface ca.macewan.lmsreporter.api.Analyzer

The Analyzer object needs to keep a list of AnalysisListeners and notify them of analysis start, progress, finish and errors.

run() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Runs the actual analysis.

S

setComponent(Component) - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Sets the component to be displayed when sending the event as type TYPE_REQUEST_UI_DISPLAY.

setDescription(String) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

The application may set a description for this Analyzer object which will be used in the analyzer selection list.

setDescription(String) - Method in interface ca.macewan.lmsreporter.api.Analyzer

The application may set an alternate description for this Analyzer object which will be used in the analyzer selection list.

setError(Throwable) - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Sets the error that occurred in the analysis.

setInfo(String) - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Sets an information message to be displayed to the user in conjunction with this event.

setProgress(double) - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Sets the level of progress for the analysis.

setRunning(boolean) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Causes isRunning to return the value passed in here.

setSources(File, File, File) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Accepts and stores the two input files and the output file used by the analysis.

setSources(File, File, File) - Method in interface ca.macewan.lmsreporter.api.Analyzer

Accepts (and probably stores) the two input files and the output file used by the analysis.

setType(int) - Method in class ca.macewan.lmsreporter.api.AnalysisEvent

Sets the event type.

setWaitingForUI(boolean) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Called by the application when the additional user interface action has completed.

setWaitingForUI(boolean) - Method in interface ca.macewan.lmsreporter.api.Analyzer

This method will be called after an AnalysisEvent.TYPE_REQUEST_UI_DISPLAY request by this Analyzer object has completed.

stopAnalysis(String) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Cause the analysis to stop prematurely.

stopAnalysis(String) - Method in interface ca.macewan.lmsreporter.api.Analyzer

Called when the application wants to interrupt the analysis.

T

TYPE_ERROR - Static variable in class ca.macewan.lmsreporter.api.AnalysisEvent

The event type signaling an error occurred in the analysis.

TYPE_FINISHED - Static variable in class ca.macewan.lmsreporter.api.AnalysisEvent

The event type signaling the analysis finished.

TYPE_PROGRESS - Static variable in class ca.macewan.lmsreporter.api.AnalysisEvent

The event type signaling the level of progress of the analysis.

TYPE_REQUEST_UI_DISPLAY - Static variable in class ca.macewan.lmsreporter.api.AnalysisEvent

The event type signaling the analysis requests a supplementary user interface element to be displayed.

TYPE_STARTED - Static variable in class ca.macewan.lmsreporter.api.AnalysisEvent

The event type signaling the analysis started.

toString() - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Overrides Object.toString() to provide a human-readable description to be displayed in the application's analysis selection list.

U

updateProgress(double) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Utility method to aid in the sending of progress AnalysisEvents.

updateProgress(double, String) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Utility method to aid in the sending of progress AnalysisEvents.

updateWithError(Throwable) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

Utility method to aid in the sending of error AnalysisEvents.

updateWithUIRequest(Component, String) - Method in class ca.macewan.lmsreporter.api.AbstractAnalyzer

If, for some reason, your analysis needs to interact with the user in the midst of the anlysis process, this method will help send the appropriate AnalysisEvent.

A C F G I L M P R S T U