org.apache.commons.chain.web
Class AbstractGetLocaleCommand

java.lang.Object
  extended by org.apache.commons.chain.web.AbstractGetLocaleCommand
All Implemented Interfaces:
Command
Direct Known Subclasses:
FacesGetLocaleCommand, PortletGetLocaleCommand, ServletGetLocaleCommand

public abstract class AbstractGetLocaleCommand
extends Object
implements Command

Abstract base Command implementation for retrieving the requested Locale from our Context, and storing it under the context attribute key returned by the localeKey property.

Version:
$Revision: 480477 $ $Date: 2006-11-29 08:34:52 +0000 (Wed, 29 Nov 2006) $
Author:
Craig R. McClanahan

Field Summary
 
Fields inherited from interface org.apache.commons.chain.Command
CONTINUE_PROCESSING, PROCESSING_COMPLETE
 
Constructor Summary
AbstractGetLocaleCommand()
           
 
Method Summary
 boolean execute(Context context)
          Retrieve the Locale for this request, and store it under the specified context attribute.
protected abstract  Locale getLocale(Context context)
          Retrieve and return the Locale for this request.
 String getLocaleKey()
          Return the context attribute key under which we will store the request Locale.
 void setLocaleKey(String localeKey)
          Set the context attribute key under which we will store the request Locale.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractGetLocaleCommand

public AbstractGetLocaleCommand()
Method Detail

getLocaleKey

public String getLocaleKey()

Return the context attribute key under which we will store the request Locale.

Returns:
The context attribute key of the request Locale.

setLocaleKey

public void setLocaleKey(String localeKey)

Set the context attribute key under which we will store the request Locale.

Parameters:
localeKey - The new context attribute key

execute

public boolean execute(Context context)
                throws Exception

Retrieve the Locale for this request, and store it under the specified context attribute.

Specified by:
execute in interface Command
Parameters:
context - The Context we are operating on
Returns:
false so that processng will continue
Throws:
Exception - If an error occurs during execution.

getLocale

protected abstract Locale getLocale(Context context)

Retrieve and return the Locale for this request.

Parameters:
context - The Context we are operating on.
Returns:
The Locale for the request.


Copyright 2003-2008 The Apache Software Foundation. All Rights Reserved.