Message.java

/**
 * JHOVE2 - Next-generation architecture for format-aware characterization
 *
 * Copyright (c) 2009 by The Regents of the University of California,
 * Ithaka Harbors, Inc., and The Board of Trustees of the Leland Stanford
 * Junior University.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * o Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * o Neither the name of the University of California/California Digital
 *   Library, Ithaka Harbors/Portico, or Stanford University, nor the names of
 *   its contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package org.jhove2.core;

import java.util.Locale;

import org.jhove2.config.ConfigInfo;

import com.sleepycat.persist.model.Persistent;

/**
 * JHOVE2 message. A message has a severity, a context, and a text code.
 * Messages are localized.
 *
 * TODO: Document how messages are used.
 * 
 * @author slabrams, smorrissey
 * 
 */
@Persistent
public class Message {
	/** Message contexts. */
	public enum Context {
          /**
           * TODO: define.
           */
          PROCESS,
          /**
           * TODO: define.
           */
          OBJECT
	}
	/** Message severities. */
	public enum Severity {

          /**
           * TODO: define.
           */
          ERROR,
          /**
           * TODO: define.
           */
          WARNING,
          /**
           * TODO: define.
           */
          INFO
	}
	/** Message code. */
	protected String messageCode;

	/** Localized Message Text */
	protected String localizedMessageText;

	/** Message context. */
	protected Context context;

	/** Message severity. */
	protected Severity severity;

	/** Message Locale. */
	protected Locale locale;
	
        /**
         * TODO: explain why a message needs configuration information
         */
        protected ConfigInfo configInfo;

	/** Default Locale */
	private static Locale defaultLocale;

		static {
			defaultLocale = Locale.getDefault();
		}

	@SuppressWarnings("unused")
	private Message() throws JHOVE2Exception{
		this(null, null, null, null);
	}
	/**
	 * Instantiate a new localized <code>Message</code>.
	 * 
	 * @param severity
	 *            Message severity
	 * @param context
	 *            Message context
	 * @param messageCode
	 *            Key to message text in localized property file
	 * @param configInfo TODO
	 * @throws JHOVE2Exception 
	 */
	public Message(Severity severity, Context context, String messageCode, ConfigInfo configInfo)
		throws JHOVE2Exception
	{
		this(severity, context, messageCode, new Object[0], defaultLocale, configInfo);
	}
	
	/**
	 * Instantiate a new localized <code>Message</code>.
	 * 
	 * @param severity
	 *            Message severity
	 * @param context
	 *            Message context
	 * @param messageCode
	 *            Key to message text in localized property file
	 * @param messageArgs
	 * 	          Arguments to message format template
	 * @param configInfo 
	 *            ConfigInfo containing method to localize method text
	 * @throws JHOVE2Exception
	 */
	public Message(Severity severity, Context context, String messageCode,
			       Object[] messageArgs, ConfigInfo configInfo) 
		throws JHOVE2Exception
	{
		this(severity, context, messageCode, messageArgs, defaultLocale, configInfo);
	}

	/**
	 * Instantiate a new localized <code>Message</code>.
	 * 
	 * @param severity
	 *            Message severity
	 * @param context
	 *            Message context
	 * @param messageCode
	 *            Key to message text in localized property file
	 * @param messageArgs
	 * 	          Arguments to message format template
	 * @param locale
	 * 			  Locale for message text
	 * @param configInfo TODO
	 * @throws JHOVE2Exception
	 */
	public Message(Severity severity, Context context, String messageCode, 
			       Object[] messageArgs, Locale locale, ConfigInfo configInfo)
		throws JHOVE2Exception
	{
		this.severity = severity;
		this.context = context;
		this.locale = locale;
		this.messageCode = messageCode;
		this.configInfo = configInfo;
		this.localizedMessageText = this.localizeMessageText(messageCode, messageArgs, locale);
	}

	/**
	 * Resolves message code and produces localized message text
	 * @param messageCode
	 *            Key to message text in localized property file
	 * @param messageArgs
	 * 			  Arguments to message format template
	 * @param locale
	 *             Locale for message text
	 * @return  
	 *         Localized formatted message text
	 * @throws JHOVE2Exception
	 */
	protected String localizeMessageText(String messageCode, Object[] messageArgs,
			                             Locale locale) 
		throws JHOVE2Exception
	{
		String localizedMessage = null;
		if (this.getConfigInfo() != null && messageCode != null && locale != null)
		localizedMessage = this.getConfigInfo().getLocalizedMessageText(messageCode, 
				messageArgs, locale);
		return localizedMessage;
	}

	/** Get message context.
	 * @return Message context
	 */
	public Context getContext() {
		return context;
	}

	/** Get localized message text.
	 * @return Localized message text
	 */
	public String getLocalizedMessageText() {
		return localizedMessageText;
	}

	/** Get message code.
	 * @return Message code
	 */
	public String getMessageCode() {
		return messageCode;
	}

	/** Get message severity
	 * @return Message severity
	 */
	public Severity getSeverity() {
		return severity;
	}

	/** Set message context.
	 * @param context Message context
	 */
	public void setContext(Context context) {
		this.context = context;
	}

	/** Set localized message text.
	 * @param localizedMessageText Localized message text
	 */
	public void setLocalizedMessageText(String localizedMessageText) {
		this.localizedMessageText = localizedMessageText;
	}
	
	/** Set message code.
	 * @param messageCode Message code
	 */
	public void setMessageCode(String messageCode) {
		this.messageCode = messageCode;
	}

	/** Set message severity.
	 * @param severity Message severity
	 */
	public void setSeverity(Severity severity) {
		this.severity = severity;
	}

	/**
	 * Get {@link java.lang.String} representation of the message.
	 */
	@Override
	public String toString() {
		return "[" + this.severity + "/" + this.context + "] " + this.localizedMessageText;
	}

	/**
	 * @return the configInfo
	 */
	public ConfigInfo getConfigInfo() {
		return configInfo;
	}

	/**
	 * @param configInfo the configInfo to set
	 */
	public void setConfigInfo(ConfigInfo configInfo) {
		this.configInfo = configInfo;
	}
}