/*
 * 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 java.util.List;

import pcgen.cdom.base.CDOMObject;
import pcgen.cdom.enumeration.CharID;
import pcgen.cdom.enumeration.ListKey;
import pcgen.cdom.facet.CDOMObjectConsolidationFacet;
import pcgen.cdom.facet.base.AbstractSourcedListFacet;
import pcgen.cdom.facet.event.DataFacetChangeEvent;
import pcgen.cdom.facet.event.DataFacetChangeListener;
import pcgen.core.Movement;

/**
 * MovementFacet is a Facet that tracks the Movement objects that are contained
 * in a Player Character.
 * 
 * @author Thomas Parker (thpr [at] yahoo.com)
 */
public class MovementFacet extends AbstractSourcedListFacet<CharID, Movement> implements
		DataFacetChangeListener<CharID, CDOMObject>
{

	private CDOMObjectConsolidationFacet consolidationFacet;

	/**
	 * Adds to this Facet the Movement objects contained within a CDOMObject
	 * granted to the Player Character.
	 * 
	 * Triggered when one of the Facets to which MovementFacet 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();
		/*
		 * TODO Should consider here whether this should get input from
		 * BaseMovementFacet vs. capturing these directly. The reason that this
		 * is done directly is that BaseMovementFacet would have to override
		 * methods to get this add done, so that is risky, then since this is
		 * already listening to the consolidated objectfacet, yet another class
		 * would be required to do the listening for Movement objects added into
		 * BaseMovementFacet. This is not unreasonable, though perhaps not pure
		 * in that this uses to ListKey objects.
		 */
		List<Movement> ml = cdo.getListFor(ListKey.BASE_MOVEMENT);
		if (ml != null)
		{
			addAll(dfce.getCharID(), ml, cdo);
		}
		ml = cdo.getListFor(ListKey.MOVEMENT);
		if (ml != null)
		{
			addAll(dfce.getCharID(), ml, cdo);
		}
	}

	/**
	 * Removes from this Facet the Movement objects contained within a
	 * CDOMObject removed from the Player Character.
	 * 
	 * Triggered when one of the Facets to which MovementFacet 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());
	}

	public void setConsolidationFacet(CDOMObjectConsolidationFacet consolidationFacet)
	{
		this.consolidationFacet = consolidationFacet;
	}

	/**
	 * Initializes the connections for MovementFacet to other facets.
	 * 
	 * This method is automatically called by the Spring framework during
	 * initialization of the MovementFacet.
	 */
	public void init()
	{
		consolidationFacet.addDataFacetChangeListener(this);
	}
}