/*
 * Copyright 2015 (C) Thomas 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.persistence.token;

import java.util.Collection;
import java.util.Set;
import java.util.TreeSet;

import pcgen.cdom.enumeration.ListKey;
import pcgen.core.Campaign;
import pcgen.persistence.lst.CampaignSourceEntry;
import pcgen.rules.context.Changes;
import pcgen.rules.context.LoadContext;

/**
 * AbstractBasicCampaignToken is an abstract token that is a template for how
 * most CampaignSourceEntry based tokens in Campaign (PCC) files work. This
 * provides the basic parsing, all the implementing token needs to provide is
 * the exact token name and the ListKey in which the CampaignSourceEntries
 * should be stored.
 */
public abstract class AbstractBasicCampaignToken extends
		AbstractTokenWithSeparator<Campaign>
{

	@Override
	protected char separator()
	{
		return '|';
	}

	@Override
	protected ParseResult parseTokenWithSeparator(LoadContext context,
		Campaign campaign, String value)
	{
		CampaignSourceEntry cse =
				context.getCampaignSourceEntry(campaign, value);
		if (cse == null)
		{
			return ParseResult.INTERNAL_ERROR;
		}
		context.getObjectContext().addToList(campaign, getListKey(), cse);
		return ParseResult.SUCCESS;
	}

	/**
	 * The ListKey indicating the List in which the CampaignSourceEntries for
	 * this token should be stored when a Campaign is being loaded.
	 * 
	 * @return The ListKey indicating the List in which the
	 *         CampaignSourceEntries for this token should be stored when a
	 *         Campaign is being loaded
	 */
	protected abstract ListKey<CampaignSourceEntry> getListKey();

	public String[] unparse(LoadContext context, Campaign campaign)
	{
		Changes<CampaignSourceEntry> cseChanges =
				context.getObjectContext().getListChanges(campaign,
					getListKey());
		Collection<CampaignSourceEntry> added = cseChanges.getAdded();
		if (added == null)
		{
			//empty indicates no token
			return null;
		}
		Set<String> set = new TreeSet<>();
		for (CampaignSourceEntry cse : added)
		{
			set.add(cse.getLSTformat());
		}
		return set.toArray(new String[set.size()]);
	}

	@Override
	public Class<Campaign> getTokenClass()
	{
		return Campaign.class;
	}
}