/*
    * Copyright 2001,2004 The Apache Software Foundation.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * 
    *      http://www.apache.org/licenses/LICENSE-2.0
    * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.commons.scaffold.util;
  
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.Comparator;
  import java.util.Iterator;
  import java.util.HashMap;
  import java.util.List;
  
  // ------------------------------------------------------------------------ 78
  
  public class MessagesImpl implements Serializable,Messages {
  
  	/**
  	 * The accumulated set of <code>Message</code> objects (represented
  	 * as an ArrayList) for each property, keyed by property name.
  	 */
  	protected HashMap messages = new HashMap();
  
  	/**
  	 * The current number of the property/key being added.  This is used
  	 * to maintain the order messages are added.
  	*/
  	protected int iCount = 0;
  
  	// --------------------------------------------------------- Public Methods
  
  	/**
  	 * Create an empty <code>Messages</code> object.
  	 */
  	public MessagesImpl() {
  		super();
  	}
  
  	/**
  	 * Create an <code>AMessages</code> object initialized with the given 
  	 * messages.
  	 * 
  	 * @param messages The messages to be initially added to this object.
  	 * @since Struts 1.1
  	 */
  	public MessagesImpl(Messages messages) {
  		super();
  		this.add(messages);
  	}
  
  
  	// See interface for JavaDoc
  	public void add(String property, Message message) {
  
  		MessageItem item = (MessageItem) messages.get(property);
  		List list = null;
  
  		if (item == null) {
  			list = new ArrayList();
  			item = new MessageItem(list, iCount++);
  
  			messages.put(property, item);
  		} else {
  			list = item.getList();
  		}
  
  		list.add(message);
  
  	}
  
  
  	// See interface for JavaDoc
  	public void add(Message message) {
  		
  		add(Messages.GLOBAL_MESSAGE_KEY,message);
  	}
  
  
  	// See interface for JavaDoc
  	public void add(Messages messages) {
  		// loop over properties
  		Iterator props = messages.properties();
  		while (props.hasNext()) {
  			String property = (String) props.next();
  
 			// loop over messages for each property
 			Iterator msgs = messages.get(property);
 			while (msgs.hasNext()) {
 				Message msg = (Message) msgs.next();
 				this.add(property, msg);
 			}
 
 		}
 	}
 
 	// See interface for JavaDoc
 	public void clear() {
 
 		messages.clear();
 
 	}
 
 	// See interface for JavaDoc
 	public boolean empty() {
 		return (this.isEmpty());
 	}
 	
 	// See interface for JavaDoc
 	public boolean isEmpty(){
 		return (messages.isEmpty());	
 	}
 
 	// See interface for JavaDoc
 	public Iterator get() {
 
 		if (messages.size() == 0) {
 			return (Collections.EMPTY_LIST.iterator());
 		}
 
 		ArrayList results = new ArrayList();
 		ArrayList actionItems = new ArrayList();
 
 		for (Iterator i = messages.values().iterator(); i.hasNext();) {
 			actionItems.add(i.next());
 		}
 
 		// Sort MessageItems based on the initial order the
 		// property/key was added to Messages.
 		Collections.sort(actionItems, new Comparator() {
 			public int compare(Object o1, Object o2) {
 				return ((MessageItem) o1).getOrder() - ((MessageItem) o2).getOrder();
 			}
 		});
 
 		for (Iterator i = actionItems.iterator(); i.hasNext();) {
 			MessageItem ami = (MessageItem) i.next();
 
 			for (Iterator messages = ami.getList().iterator(); messages.hasNext();) {
 				results.add(messages.next());
 			}
 		}
 
 		return (results.iterator());
 
 	}
 
 	// See interface for JavaDoc
 	public Iterator get(String property) {
 
 		MessageItem item = (MessageItem) messages.get(property);
 
 		if (item == null) {
 			return (Collections.EMPTY_LIST.iterator());
 		} else {
 			return (item.getList().iterator());
 		}
 		
 	}
 
 	// See interface for JavaDoc
 	public Iterator properties() {
 
 		return (messages.keySet().iterator());
 
 	}
 
 	// See interface for JavaDoc
 	public int size() {
 
 		int total = 0;
 
 		for (Iterator i = messages.values().iterator(); i.hasNext();) {
 			MessageItem ami = (MessageItem) i.next();
 			total += ami.getList().size();
 		}
 
 		return (total);
 
 	}
 
 	// See interface for JavaDoc
 	public int size(String property) {
 
 		MessageItem ami = (MessageItem) messages.get(property);
 
 		if (ami == null)
 			return (0);
 		else
 			return (ami.getList().size());
 
 	}
 
 	// See interface for JavaDoc
 	protected class MessageItem implements Serializable {
 
 		/**
 		 * The list of <code>Message</code>s.
   		 */
 		protected List list = null;
 
 		/**
 		 * The position in the list of messages.
 		 */
 		protected int iOrder = 0;
 
 		public MessageItem(List list, int iOrder) {
 			this.list = list;
 			this.iOrder = iOrder;
 		}
 
 		public List getList() {
 			return list;
 		}
 
 		public void setList(List list) {
 			this.list = list;
 		}
 
 		public int getOrder() {
 			return iOrder;
 		}
 
 		public void setOrder(int iOrder) {
 			this.iOrder = iOrder;
 		}
 
 	}
 
 } // end MessagesImpl