/*
 * Copyright (c) Thomas Parker, 2009.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 * 
 * 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 Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
package pcgen.cdom.facet.analysis;

import pcgen.cdom.base.CDOMObject;
import pcgen.cdom.base.ItemFacet;
import pcgen.cdom.enumeration.CharID;
import pcgen.cdom.enumeration.ObjectKey;
import pcgen.cdom.facet.base.AbstractSourcedListFacet;
import pcgen.cdom.facet.event.DataFacetChangeEvent;
import pcgen.cdom.facet.event.DataFacetChangeListener;
import pcgen.cdom.facet.model.RaceFacet;
import pcgen.cdom.facet.model.TemplateFacet;
import pcgen.output.publish.OutputDB;

/**
 * HasAnyFavoredClassFacet is a Facet that tracks if the Player Character has
 * "ANY" ("HIGHESTCLASS") as a Favored Class.
 * 
 * @author Thomas Parker (thpr [at] yahoo.com)
 */
public class HasAnyFavoredClassFacet extends AbstractSourcedListFacet<CharID, Boolean>
		implements DataFacetChangeListener<CharID, CDOMObject>, ItemFacet<CharID, Boolean>
{

	private RaceFacet raceFacet;

	private TemplateFacet templateFacet;

	/**
	 * Adds the Any Favored Class capability granted by CDOMObjects added to the
	 * Player Character to this HasAnyFavoredClassFacet.
	 * 
	 * Triggered when one of the Facets to which HasAnyFavoredClassFacet listens
	 * fires a DataFacetChangeEvent to indicate a CDOMObject was added to a
	 * Player Character.
	 * 
	 * @param dfce
	 *            The DataFacetChangeEvent containing the information about the
	 *            change
	 * 
	 * @see pcgen.cdom.facet.event.DataFacetChangeListener#dataAdded(pcgen.cdom.facet.event.DataFacetChangeEvent)
	 */
	@Override
	public void dataAdded(DataFacetChangeEvent<CharID, CDOMObject> dfce)
	{
		CDOMObject cdo = dfce.getCDOMObject();
		Boolean hdw = cdo.get(ObjectKey.ANY_FAVORED_CLASS);
		if (hdw != null)
		{
			add(dfce.getCharID(), hdw, cdo);
		}
	}

	/**
	 * Removes the Any Favored Class capability granted by CDOMObjects removed
	 * from the Player Character from this HasAnyFavoredClassFacet.
	 * 
	 * Triggered when one of the Facets to which HasAnyFavoredClassFacet listens
	 * fires a DataFacetChangeEvent to indicate a CDOMObject was removed from a
	 * Player Character.
	 * 
	 * @param dfce
	 *            The DataFacetChangeEvent containing the information about the
	 *            change
	 * 
	 * @see pcgen.cdom.facet.event.DataFacetChangeListener#dataRemoved(pcgen.cdom.facet.event.DataFacetChangeEvent)
	 */
	@Override
	public void dataRemoved(DataFacetChangeEvent<CharID, CDOMObject> dfce)
	{
		removeAll(dfce.getCharID(), dfce.getCDOMObject());
	}

	/**
	 * Initializes the connections for HasAnyFavoredClassFacet to other facets.
	 * 
	 * This method is automatically called by the Spring framework during
	 * initialization of the HasAnyFavoredClassFacet.
	 */
	public void init()
	{
		raceFacet.addDataFacetChangeListener(this);
		templateFacet.addDataFacetChangeListener(this);
		OutputDB.register("hasanyfavoredclass", this);
	}

	public void setRaceFacet(RaceFacet raceFacet)
	{
		this.raceFacet = raceFacet;
	}

	public void setTemplateFacet(TemplateFacet templateFacet)
	{
		this.templateFacet = templateFacet;
	}

	@Override
	public Boolean get(CharID id)
	{
		return contains(id, Boolean.TRUE);
	}

}