/*
 * 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.factset;

import pcgen.base.util.FormatManager;
import pcgen.cdom.base.CDOMObject;
import pcgen.cdom.enumeration.FactSetKey;

/**
 * FactSetInfo represents the key information required in order to use a
 * FactSet. This includes the usable location, the name, and the FormatManager
 * that can process the objects of the type in the FactSet.
 * 
 * @param <T>
 *            The Type of object upon which the underlying FactSet for this
 *            FactSetInfo can be applied
 * @param <F>
 *            The format of the objects stored in the FactSet
 */
public interface FactSetInfo<T extends CDOMObject, F>
{

	/**
	 * Returns the FormatManager for this FactSetInfo. This is used to convert
	 * to/from the String format used to serialize content for LST files.
	 * 
	 * @return The FormatManager for this FactSetInfo
	 */
	public FormatManager<F> getFormatManager();

	/**
	 * Returns the "usable location" of this FactSetInfo (related to what LST
	 * files this FactSetInfo will be usable within).
	 * 
	 * @return The "usable location" of this FactSetInfo
	 */
	public Class<T> getUsableLocation();

	/**
	 * Returns the Fact Name for this FactSetInfo. This effectively serves as
	 * the subtoken name in the LST data.
	 * 
	 * @return The Fact Name for this FactSetInfo
	 */
	public String getFactSetName();

	/**
	 * Returns the FactSetKey for this FactSetInfo.
	 * 
	 * @return The FactSetKey for this FactSetInfo
	 */
	public FactSetKey<F> getFactSetKey();

}