/*
 * Copyright 2007 (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.rules.context;

import java.net.URI;
import java.util.Collection;
import java.util.List;

import pcgen.base.formula.base.ScopeInstance;
import pcgen.cdom.base.CDOMObject;
import pcgen.cdom.base.CDOMReference;
import pcgen.cdom.base.GroupDefinition;
import pcgen.cdom.base.Loadable;
import pcgen.cdom.base.PrimitiveCollection;
import pcgen.cdom.enumeration.DataSetID;
import pcgen.cdom.reference.ReferenceManufacturer;
import pcgen.cdom.reference.SelectionCreator;
import pcgen.core.Campaign;
import pcgen.core.prereq.Prerequisite;
import pcgen.persistence.PersistenceLayerException;
import pcgen.persistence.lst.CampaignSourceEntry;
import pcgen.rules.persistence.token.ParseResult;

public interface LoadContext
{

	/*
	 * Source Info
	 */
	public void setExtractURI(URI extractURI);

	public void setSourceURI(URI sourceURI);

	public URI getSourceURI();

	/*
	 * Context info
	 */
	public DataSetID getDataSetID();

	public AbstractReferenceContext getReferenceContext();

	public AbstractObjectContext getObjectContext();

	public AbstractListContext getListContext();
	
	public boolean consolidate();

	/*
	 * Token Processing (State Machine)
	 */
	public void commit();

	public void rollback();

	/*
	 * Token Content
	 */
	public void resolveDeferredTokens();

	public void resolvePostDeferredTokens();

	public void resolvePostValidationTokens();

	public <T extends CDOMObject> PrimitiveCollection<T> getChoiceSet(
		SelectionCreator<T> sc, String value);

	public <T extends CDOMObject> PrimitiveCollection<T> getPrimitiveChoiceFilter(
		SelectionCreator<T> sc, String key);

	public String getPrerequisiteString(Collection<Prerequisite> prereqs);

	public ReferenceManufacturer<? extends Loadable> getManufacturer(
		String firstToken);

	public void forgetMeNot(CDOMReference<?> cdr);

	/*
	 * Loader Content
	 */
	public <T extends CDOMObject> T cloneConstructedCDOMObject(T cdo,
		String newName);

	public CampaignSourceEntry getCampaignSourceEntry(Campaign source,
		String value);

	public void clearStatefulInformation();

	public boolean addStatefulToken(String s) throws PersistenceLayerException;

	public void addStatefulInformation(CDOMObject target);

	public void setLoaded(List<Campaign> campaigns);

	public List<Campaign> getLoadedCampaigns();
	
	public void loadCampaignFacets();

	public <T extends CDOMObject> T performCopy(T object, String copyName);
	
	/*
	 * Token Processing (direct)
	 */
	public <T> ParseResult processSubToken(T cdo, String tokenName, String key,
		String value);

	public <T extends Loadable> boolean processToken(T derivative,
		String typeStr, String argument) throws PersistenceLayerException;

	public <T extends Loadable> void unconditionallyProcess(T cdo, String key,
		String value);

	public <T> String[] unparseSubtoken(T cdo, String tokenName);

	public <T> Collection<String> unparse(T cdo);

	/*
	 * Output Messages
	 */
	public void addWriteMessage(String string);

	public int getWriteMessageCount();

	/**
	 * Loads a token "local" to this LoadContext (meaning it is local to the
	 * data currently loaded and does not apply to all future data that may be
	 * loaded [with a different LoadContext since a LoadContext is not
	 * reusable]).
	 * 
	 * This is used for dynamic tokens, such as those produced from a FACTDEF or
	 * FACTSETDEF
	 * 
	 * @param token
	 *            The "local" token to be loaded into this LoadContext
	 */
	public void loadLocalToken(Object token);
	
	public <T> GroupDefinition<T> getGroup(Class<T> cl, String s);

	LoadContext dropIntoContext(String scope);

	VariableContext getVariableContext();

	public ScopeInstance getActiveScope();
}