/*
 * SSSync, a Simple and Stupid Synchronizer for data with multi-valued attributes
 * Copyright (C) 2014  Ludovic Pouzenc <ludovic@pouzenc.fr>
 *  
 * This file is part of SSSync.
 *
 *  SSSync is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  SSSync 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with SSSync.  If not, see <http://www.gnu.org/licenses/>
 */

package data.io;

import java.util.Set;

import data.MVDataEntry;

/**
 * Stream-oriented abstract writer from a particular data source.
 * All derived writers should honor a dry-run mode.
 * 
 * @author lpouzenc
 */
public abstract class AbstractMVDataWriter implements MVDataWriter {
	//TODO : not so useful. Interface extraction was not a good idea ?
	
	/**
	 * Dry-run mode flag (disabled by default)
	 */
	protected boolean dryRun=false;
	
	/* (non-Javadoc)
	 * @see data.io.MVDataWriter#isDryRun()
	 */
	public boolean isDryRun() {
		return dryRun;
	}

	/* (non-Javadoc)
	 * @see data.io.MVDataWriter#setDryRun(boolean)
	 */
	public void setDryRun(boolean dryRun) {
		this.dryRun = dryRun;
	}
	
	/* (non-Javadoc)
	 * @see data.io.MVDataWriter#insert(data.MVDataEntry)
	 */
	@Override
	public abstract void insert(MVDataEntry newEntry) throws Exception;
	/* (non-Javadoc)
	 * @see data.io.MVDataWriter#update(data.MVDataEntry, data.MVDataEntry, java.util.Set)
	 */
	@Override
	public abstract void update(MVDataEntry updatedEntry,  MVDataEntry originalEntry, Set<String> attrToUpdate) throws Exception;
	/* (non-Javadoc)
	 * @see data.io.MVDataWriter#delete(data.MVDataEntry)
	 */
	@Override
	public abstract void delete(MVDataEntry existingEntry) throws Exception;
}