com.screenscraper.hmvc

Class AbstractController

java.lang.Object

com.screenscraper.hmvc.AbstractController

Direct Known Subclasses:

ControllerExtractorPattern, ControllerHTTPSession, ControllerMain, ControllerMainFrame, ControllerNavigationAction, ControllerScrapeableFile, ControllerScrapingSession, ControllerScript, ControllerScriptInstances, ControllerTree

public abstract class AbstractController
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
AbstractController()

Method Summary

Modifier and Type	Method and Description
void	createChildTriad(AbstractModel childModel, AbstractView childView, AbstractController childController) Creates a child triad.
void	createChildTriad(AbstractModel childModel, AbstractView childView, AbstractController childController, java.lang.String identifier) Creates a child triad.
void	createChildTriad(AbstractView childView, AbstractController childController) Creates a child triad (or, ahem, diad), sans the model.
AbstractController	getChildController(java.lang.String identifier) Gets a child controller associated with this controller.
java.util.Iterator<AbstractController>	getChildControllersIterator() Gets an Enumeration over which the child controllers held by this controller can be enumerated.
protected java.lang.String	getIdentifier() Gets the identifier of the controller.
AbstractModel	getModel() Gets the model associated with this controller.
int	getNumChildControllers() Gets the number of child controllers
AbstractController	getParentController() Gets the parent controller of this controller.
AbstractView	getView() Gets the view associated with this controller.
abstract void	handleAppEvent(AppEvent evt) Allows the controller to handle AppEvents.
void	removeAllChildControllers() Removes all child controllers.
void	removeChildController(java.lang.String id) Removes a child controller from those associated with this controller.
protected void	setIdentifier(java.lang.String identifier) Sets the identifier of the controller.
void	setModel(AbstractModel model) Sets the model associated with this controller.
void	setParentController(AbstractController ctrl) Sets the parent controller of this controller.
void	setView(AbstractView view) Sets the view associated with this controller.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

AbstractController

public AbstractController()

Method Detail

createChildTriad

public void createChildTriad(AbstractModel childModel,
                             AbstractView childView,
                             AbstractController childController,
                             java.lang.String identifier)

Creates a child triad.

Parameters:

childModel - The model in the triad.

childView - The view in the triad.

childController - The controller in the triad.

identifier - A String used to identify the triad.

createChildTriad

public void createChildTriad(AbstractModel childModel,
                             AbstractView childView,
                             AbstractController childController)

Creates a child triad. Uses the class name of the controller as the identifier.

Parameters:

childModel - The model in the triad.

childView - The view in the triad.

childController - The controller in the triad.

createChildTriad

public void createChildTriad(AbstractView childView,
                             AbstractController childController)

Creates a child triad (or, ahem, diad), sans the model. Uses the class name of the controller as the identifier.

Parameters:

childView - The view in the triad.

childController - The controller in the triad.

getChildController

public AbstractController getChildController(java.lang.String identifier)

Gets a child controller associated with this controller.

Parameters:

identifier - The identifier associated with the desired child controller.

Returns:

The controller for the given identifier, or null if there is none

setParentController

public void setParentController(AbstractController ctrl)

Sets the parent controller of this controller.

Parameters:

ctrl - The controller to act as the parent.

getParentController

public AbstractController getParentController()

Gets the parent controller of this controller.

Returns:

The parent controller.

getIdentifier

protected java.lang.String getIdentifier()

Gets the identifier of the controller.

Returns:

The identifier.

setIdentifier

protected void setIdentifier(java.lang.String identifier)

Sets the identifier of the controller.

Parameters:

identifier - The identifier.

setModel

public void setModel(AbstractModel model)

Sets the model associated with this controller.

Parameters:

model - The model.

getModel

public AbstractModel getModel()

Gets the model associated with this controller.

Returns:

The model.

setView

public void setView(AbstractView view)

Sets the view associated with this controller.

Parameters:

view - The view.

getView

public AbstractView getView()

Gets the view associated with this controller.

Returns:

The view.

handleAppEvent

public abstract void handleAppEvent(AppEvent evt)

Allows the controller to handle AppEvents.

Parameters:

evt - The AppEvent to handle.

getNumChildControllers

public int getNumChildControllers()

Gets the number of child controllers

Returns:

The number of child controllers held by this controller.

getChildControllersIterator

public java.util.Iterator<AbstractController> getChildControllersIterator()

Gets an Enumeration over which the child controllers held by this controller can be enumerated.

Returns:

The Enumeration pointing to AbstractController objects.

removeChildController

public void removeChildController(java.lang.String id)

Removes a child controller from those associated with this controller.

Parameters:

id - The id of the child controller to remove.

removeAllChildControllers

public void removeAllChildControllers()

Removes all child controllers.