/*
 * Copyright (c) 2015 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 plugin.lsttokens.paper;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

import pcgen.core.PaperInfo;
import pcgen.rules.context.LoadContext;
import pcgen.rules.persistence.token.AbstractNonEmptyToken;
import pcgen.rules.persistence.token.CDOMPrimaryToken;
import pcgen.rules.persistence.token.ParseResult;
import pcgen.rules.persistence.token.PostValidationToken;
import pcgen.util.Logging;

/**
 * Processes the SORTKEY token for PaperInfo objects (Game Mode), loading it
 * into the SortKey field of the PaperInfo.
 * 
 * Note: While the intent is the same, this is necessary as a separate token
 * from the "Global" SortKey since PaperInfo does not extend CDOMObject.
 */
public class SortKeyToken extends AbstractNonEmptyToken<PaperInfo> implements
		CDOMPrimaryToken<PaperInfo>, PostValidationToken<PaperInfo>
{

	@Override
	public String getTokenName()
	{
		return "SORTKEY";
	}

	@Override
	protected ParseResult parseNonEmptyToken(LoadContext context, PaperInfo pi,
			String value)
	{
		pi.setSortKey(value);
		return ParseResult.SUCCESS;
	}

    @Override
	public String[] unparse(LoadContext context, PaperInfo pi)
	{
		String info = pi.getSortKey();
		if (info == null)
		{
			// Probably an error
			return null;
		}
		return new String[] { info };
	}

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

	@Override
	public boolean process(LoadContext context,
		Collection<? extends PaperInfo> c)
	{
		boolean returnValue = true;
		Map<String, PaperInfo> keys =
				new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
		for (PaperInfo pi : c)
		{
			String keyName = pi.getKeyName();
			if (keyName == null)
			{
				Logging.errorPrint("PaperInfo: " + pi.getDisplayName()
					+ " requires a SortKey, but was null", context);
				returnValue = false;
			}
			else if (keys.put(keyName, pi) != null)
			{
				Logging.errorPrint(
					"Found more than one PaperInfo with (case insensitive) Sort Key: "
						+ keyName, context);
				returnValue = false;
			}
		}
		List<PaperInfo> coll = new ArrayList<>(keys.values());
		List<PaperInfo> sorted =
				context.getReferenceContext().getOrderSortedCDOMObjects(
					PaperInfo.class);
		//Remove this check after 6.6
		if (!coll.equals(sorted))
		{
			Logging.errorPrint(
				"SORTKEY sorting in PaperInfo did not match file order",
				context);
			returnValue = false;
		}
		return returnValue;
	}

	@Override
	public Class<PaperInfo> getValidationTokenClass()
	{
		return PaperInfo.class;
	}

	@Override
	public int getPriority()
	{
		return 0;
	}
}