/*
    * Copyright (c) 2005 Regents of the University of California (Regents). Created
    * by TELS, Graduate School of Education, University of California at Berkeley.
    *
    * This software is distributed under the GNU Lesser General Public License, v2.
    *
    * Permission is hereby granted, without written agreement and without license
    * or royalty fees, to use, copy, modify, and distribute this software and its
    * documentation for any purpose, provided that the above copyright notice and
   * the following two paragraphs appear in all copies of this software.
   *
   * REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
   * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   * PURPOSE. THE SOFTWAREAND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED
   * HEREUNDER IS PROVIDED "AS IS". REGENTS HAS NO OBLIGATION TO PROVIDE
   * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
   *
   * IN NO EVENT SHALL REGENTS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
   * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
   * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
   * REGENTS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  package net.sf.sail.core.util;
  
  import java.awt.Image;
  import java.beans.BeanInfo;
  import java.beans.IntrospectionException;
  import java.beans.Introspector;
  import java.beans.beancontext.BeanContext;
  import java.beans.beancontext.BeanContextChild;
  import java.beans.beancontext.BeanContextServices;
  import java.io.PrintStream;
  import java.net.URL;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.HashSet;
  import java.util.logging.Level;
  import java.util.logging.Logger;
  
  import net.sf.sail.common.beansupport.IIconProvider;
  
  /**
   * Our class of utility functions for Beans and BeanContexts. Everything here is
   * generic to all JavaBean programming. Methods specific to pods go in
   * {@link PodUtils}.
   * 
   * @author turadg
   */
  public class SailBeanUtils {
  	/**
  	 * Logger for this class
  	 */
  	private static final Logger logger = Logger.getLogger(SailBeanUtils.class
  			.getName());
  
  	public static void printTree(PrintStream out, int indent,
  			Collection<?> collection) {
  		for (int i = 0; i < indent; i += 1)
  			out.print(" ");
  		out.println(collection);
  		for (Object object : collection) {
  			if (object instanceof Collection)
  				printTree(out, indent + 4, (Collection<?>) object);
  			else {
  				for (int i = 0; i < indent; i += 1)
  					out.print(" ");
  				out.print("\\   (");
  				out.print(object.getClass().getSimpleName());
  				out.print(") ");
  				out.println(object);  // object.toString() representation
  			}
  		}
  	}
  
  	public static <T> T firstChildOfType(BeanContext bc, Class<T> type) {
  		Collection<T> collection = SailBeanUtils.childrenOfType(bc, type);
  		return collection.iterator().next();
  	}
  
  	public static <T> Collection<T> childrenOfType(BeanContext bc, Class<T> type) {
  		Collection<T> found = new HashSet<T>();
  		findChildrenOfType(bc, type, found);
  		return Collections.unmodifiableCollection(found);
  	}
  
  	@SuppressWarnings("unchecked")
  	static <T> void findChildrenOfType(BeanContext bc, Class<T> type,
  			Collection<T> found) {
  		for (Object object : bc) {
  			if (type.isInstance(object)) {
  				final T typedObject = (T) object;
  				found.add(typedObject);
  			}
  			if (object instanceof BeanContext) {
  				BeanContext child = (BeanContext) object;
  				findChildrenOfType(child, type, found);
  			}
  		}
  	}
 
 	public static Image getLargeBeanIcon(Object bean) {
 		if (bean instanceof IIconProvider) {
 			URL iconUrl = ((IIconProvider) bean)
 					.getIcon(BeanInfo.ICON_COLOR_32x32);
 			if (iconUrl != null) {
 				return java.awt.Toolkit.getDefaultToolkit().getImage(iconUrl);
 			}
 		}
 
 		try {
 			BeanInfo info = Introspector.getBeanInfo(bean.getClass());
 			return info.getIcon(BeanInfo.ICON_COLOR_32x32);
 		} catch (IntrospectionException e) {
 			logger.log(Level.SEVERE, "Class -", e); //$NON-NLS-1$
 			return null;
 		}
 	}
 
 	public static Image getSmallBeanIcon(Object bean) {
 		if (bean instanceof IIconProvider) {
 			URL iconUrl = ((IIconProvider) bean)
 					.getIcon(BeanInfo.ICON_COLOR_16x16);
 			if (iconUrl != null) {
 				return java.awt.Toolkit.getDefaultToolkit().getImage(iconUrl);
 			}
 		}
 
 		try {
 			BeanInfo info = Introspector.getBeanInfo(bean.getClass());
 			Image icon = info.getIcon(BeanInfo.ICON_COLOR_16x16);
 			return icon;
 		} catch (IntrospectionException e) {
 			logger.log(Level.SEVERE, "Class -", e); //$NON-NLS-1$
 			return null;
 		}
 	}
 
 	@Deprecated
 	public static String shortNameOf(Class<?> clazz) {
 		return clazz.getSimpleName();
 	}
 
 	public static BeanContextServices findServicesContextOf(
 			BeanContextChild child) {
 		BeanContext bc = child.getBeanContext();
 
 		if (bc == null)
 			throw new RuntimeException("BeanContextChild has no bean context");
 
 		if (!(bc instanceof BeanContextServices))
 			throw new RuntimeException(
 					"BeanContextChild within a non BCS context");
 
 		BeanContextServices bcs = (BeanContextServices) bc;
 		return bcs;
 	}
 
 	/**
 	 * Helper method to find the BeanContext containing the source
 	 * 
 	 * @param source
 	 * @return BeanContext containing the source bean
 	 */
 	public static BeanContext resolveBeanContext(Object source) {
 		if (source instanceof BeanContextChild) {
 			BeanContextChild bcc = (BeanContextChild) source;
 			BeanContext pod = bcc.getBeanContext();
 			return pod;
 		}
 		return null;
 	}
 
 	/**
 	 * @param source
 	 * @return Pod containing the source bean
 	 * @deprecated use {@link PodUtils} instead
 	 */
 	@Deprecated
 	public static BeanContext resolvePod(Object source) {
 		return SailBeanUtils.resolvePod(source);
 	}
 
 }