/*
 * Copyright 2014 (C) Tom Parker <thpr@users.sourceforge.net>
 * 
 * This library 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 library 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.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
package pcgen.cdom.content.fact;

import pcgen.base.util.FormatManager;
import pcgen.base.util.ObjectContainer;
import pcgen.cdom.base.CDOMObject;
import pcgen.cdom.base.GroupDefinition;
import pcgen.cdom.enumeration.GroupingState;
import pcgen.rules.context.LoadContext;

/**
 * A FactGroupDefinition is a GroupDefinition built around a Fact, specifically
 * relying upon a FactInfo. This is effectively a factory that can generate an
 * appropriate FactGroup for a given value, based upon the FactInfo provided at
 * construction.
 * 
 * @param <T>
 *            The Type of object upon which this FactGroupDefintion can be used
 *            (the host of the fact)
 * @param <F>
 *            The Type of object this FactGroupDefinition contains (the content
 *            of the fact)
 */
public class FactGroupDefinition<T extends CDOMObject, F> implements
		GroupDefinition<T>
{

	/**
	 * The underlying FactInfo indicating static information about the Fact for
	 * which this FactGroupDefintion can create Primitives
	 */
	private final FactInfo<T, F> def;

	/**
	 * Constructs a new FactGroupDefinition with the given FactInfo.
	 * 
	 * @param fi
	 *            The FactInfo underlying this FactGroupDefinition
	 * @throws IllegalArgumentException
	 *             if the given FactInfo is null
	 */
	public FactGroupDefinition(FactInfo<T, F> fi)
	{
		if (fi == null)
		{
			throw new IllegalArgumentException("Fact Info cannot be null");
		}
		def = fi;
	}

	/**
	 * @see pcgen.cdom.base.GroupDefinition#getPrimitiveName()
	 */
	@Override
	public String getPrimitiveName()
	{
		return def.getFactName();
	}

	/**
	 * @see pcgen.cdom.base.GroupDefinition#getGroupingState()
	 */
	@Override
	public GroupingState getGroupingState()
	{
		return GroupingState.ANY;
	}

	/**
	 * @see pcgen.cdom.base.GroupDefinition#getReferenceClass()
	 */
	@Override
	public Class<T> getReferenceClass()
	{
		return def.getUsableLocation();
	}

	/**
	 * @see pcgen.cdom.base.GroupDefinition#getFormatManager()
	 */
	@Override
	public FormatManager<?> getFormatManager()
	{
		return def.getFormatManager();
	}

	/**
	 * @see pcgen.cdom.base.GroupDefinition#getPrimitive(pcgen.rules.context.LoadContext,
	 *      java.lang.String)
	 */
	@Override
	public ObjectContainer<T> getPrimitive(LoadContext context, String value)
	{
		return new FactGroup<>(context, def, value);
	}
}