Index: lams_common/src/java/org/lamsfoundation/lams/tool/OutputDefinitionFactory.java
===================================================================
diff -u
--- lams_common/src/java/org/lamsfoundation/lams/tool/OutputDefinitionFactory.java (revision 0)
+++ lams_common/src/java/org/lamsfoundation/lams/tool/OutputDefinitionFactory.java (revision 530c208895bfea0ba15e8bd8f1c799b163c059c9)
@@ -0,0 +1,223 @@
+/****************************************************************
+ * Copyright (C) 2005 LAMS Foundation (http://lamsfoundation.org)
+ * =============================================================
+ * License Information: http://lamsfoundation.org/licensing/lams/2.0/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2.0
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 * USA
+ *
+ * http://www.gnu.org/licenses/gpl.txt
+ * ****************************************************************
+ */
+
+/* $Id$ */
+package org.lamsfoundation.lams.tool;
+
+import java.util.Locale;
+import java.util.SortedMap;
+
+import org.apache.log4j.Logger;
+import org.lamsfoundation.lams.tool.exception.ToolException;
+import org.lamsfoundation.lams.util.ILoadedMessageSourceService;
+import org.lamsfoundation.lams.util.MessageService;
+
+import org.springframework.context.MessageSource;
+import org.springframework.context.NoSuchMessageException;
+import org.springframework.context.i18n.LocaleContextHolder;
+
+/**
+ * This class forms the basic implementation of an output definition factory, which is the class in a tool that
+ * creates the output definitions for a tool. Each tool that has outputs should create its own factory class that
+ * extends this class and uses the methods implemented in this class to create the actual ToolOutputDefinition objects.
+ *
+ * The implemented factory (in the tool) needs to supply either (a) its own messageService bean (a Spring bean normally
+ * defined in the tool's applicationContext file in the toolMessageService property or (b) the name of its I18N language package/filename AND
+ * the the loadedMessageSourceService (which is defined as a Spring bean in the core context). One of the two options (but not
+ * both) is required so that the getDescription() method can get the internationalised description of the output definition
+ * from the tool's internationalisation files. If neither the messageService or the I18N name is not supplied then the name
+ * if the output definition will appear in the description field.
+ *
+ * Example definitions for tool factories:
+ *
+ * LAMS_USER
* table. For more detail see org.lamsfoundation.lams.web.filter.LocaleFilter.
*
* @author Steve.Ni
* @version $Revision$
- * @see org.springframework.context.support.MessageSourceAccessor
+ * @see org.springframework.context.support.MessageSource
*/
public class MessageService {
- private MessageSourceAccessor messageAccessor;
+ private MessageSource messageSource;
/**
* Set MessageSource from spring IoC.
* @param messageSource
*/
public void setMessageSource(MessageSource messageSource){
- messageAccessor = new MessageSourceAccessor(messageSource);
+ this.messageSource = messageSource;
}
/**
+ * Set MessageSource from spring IoC.
+ * @param messageSource
+ */
+ public MessageSource getMessageSource(){
+ return this.messageSource;
+ }
+
+ /**
* @see org.springframework.context.support.MessageSourceAccessor#getMessage(java.lang.String)
* @param key
* @return
*/
public String getMessage(String key){
String message;
try {
- message = messageAccessor.getMessage(key,LocaleContextHolder.getLocale());
+ message = messageSource.getMessage(key,null,LocaleContextHolder.getLocale());
} catch (NoSuchMessageException e) {
message = "??" + key + "??";
}
@@ -69,7 +76,7 @@
public String getMessage(String key, String defaultMessage){
String message = defaultMessage;
try {
- message = messageAccessor.getMessage(key,defaultMessage,LocaleContextHolder.getLocale());
+ message = messageSource.getMessage(key,null,defaultMessage,LocaleContextHolder.getLocale());
} catch (NoSuchMessageException e) {
message = defaultMessage;
}
@@ -84,7 +91,7 @@
public String getMessage(String key, Object[] args){
String message;
try {
- message = messageAccessor.getMessage(key,args,LocaleContextHolder.getLocale());
+ message = messageSource.getMessage(key,args,LocaleContextHolder.getLocale());
} catch (NoSuchMessageException e) {
message = "??" + key + "??";
}
@@ -100,7 +107,7 @@
public String getMessage(String key, Object[] args, String defaultMessage){
String message = defaultMessage;
try {
- message = messageAccessor.getMessage(key,args,defaultMessage,LocaleContextHolder.getLocale());
+ message = messageSource.getMessage(key,args,defaultMessage,LocaleContextHolder.getLocale());
} catch (NoSuchMessageException e) {
message = defaultMessage;
}