/*
 This file belongs to the Servoy development and deployment environment, Copyright (C) 1997-2014 Servoy BV

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Affero General Public License as published by the Free
 Software Foundation; either version 3 of the License, or (at your option) any
 later version.

 This program 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 Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License along
 with this program; if not, see http://www.gnu.org/licenses or write to the Free
 Software Foundation,Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 */

package com.servoy.j2db.server.ngclient.property;

import java.util.ArrayList;
import java.util.List;

import com.servoy.j2db.dataprocessing.IRecord;
import com.servoy.j2db.dataprocessing.IRecordInternal;
import com.servoy.j2db.dataprocessing.ModificationEvent;
import com.servoy.j2db.server.ngclient.DataAdapterList;
import com.servoy.j2db.server.ngclient.IWebFormController;
import com.servoy.j2db.server.ngclient.property.types.IDataLinkedType.TargetDataLinks;

/**
 * A data adapter list that can be used to work with records of a foundset typed property.<br/>
 * As one would normally change/go over records in data adapter list to generate contents for each record,
 * this object keep track of when such record changes occur. This can be useful when for example you would not want to interpret
 * properties as changed/dirty only because you are changing the current record of the DAL to retrieve values.
 *
 * @author acostescu
 */
public class FoundsetDataAdapterList extends DataAdapterList
{

	private boolean keepQuiet = false;
	private List<IDataLinkedPropertyRegistrationListener> dataLinkedPropertyRegistrationListeners;

	public FoundsetDataAdapterList(IWebFormController formController)
	{
		super(formController);
	}

	public void setRecordQuietly(IRecord record)
	{
		keepQuiet = true;
		try
		{
			super.setRecord(record, false);
		}
		finally
		{
			keepQuiet = false;
		}
	}

	@Override
	protected boolean shouldIgnoreRecordChange(IRecord oldRecord, IRecord newRecord)
	{
		return false;
	}

	public boolean isQuietRecordChangeInProgress()
	{
		return keepQuiet;
	}

	@Override
	public void addDataLinkedProperty(IDataLinkedPropertyValue propertyValue, TargetDataLinks targetDataLinks)
	{
		super.addDataLinkedProperty(propertyValue, targetDataLinks);
		if (dataLinkedPropertyRegistrationListeners != null)
		{
			for (IDataLinkedPropertyRegistrationListener l : dataLinkedPropertyRegistrationListeners)
			{
				l.dataLinkedPropertyRegistered(propertyValue, targetDataLinks);
			}
		}
	}

	@Override
	public void removeDataLinkedProperty(IDataLinkedPropertyValue propertyValue)
	{
		super.removeDataLinkedProperty(propertyValue);
		if (dataLinkedPropertyRegistrationListeners != null)
		{
			for (IDataLinkedPropertyRegistrationListener l : dataLinkedPropertyRegistrationListeners)
			{
				l.dataLinkedPropertyUnregistered(propertyValue);
			}
		}
	}

	public void addDataLinkedPropertyRegistrationListener(IDataLinkedPropertyRegistrationListener listener)
	{
		if (dataLinkedPropertyRegistrationListeners == null) dataLinkedPropertyRegistrationListeners = new ArrayList<IDataLinkedPropertyRegistrationListener>();
		if (!dataLinkedPropertyRegistrationListeners.contains(listener)) dataLinkedPropertyRegistrationListeners.add(listener);
	}

	public void removeDataLinkedPropertyRegistrationListener(IDataLinkedPropertyRegistrationListener listener)
	{
		if (dataLinkedPropertyRegistrationListeners != null)
		{
			dataLinkedPropertyRegistrationListeners.remove(listener);
			if (dataLinkedPropertyRegistrationListeners.size() == 0) dataLinkedPropertyRegistrationListeners = null;
		}
	}

	@Override
	public void valueChanged(ModificationEvent e)
	{
		// if the current record is already not in the foundset anymore, just ignore this change.
		// this is because the row of the record could still fire a ModificationEvent change at the moment the record is removed from the foundset.
		IRecordInternal r = getRecord();
		if (r == null || r.getParentFoundSet().getRecordIndex(r) != -1)
		{
			super.valueChanged(e);
		}
	}

}