Exporter.java

/*
 * @copyright 2013 Philip Warner
 * @license GNU General Public License
 * 
 * This file is part of Book Catalogue.
 *
 * Book Catalogue 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.
 *
 * Book Catalogue 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 Book Catalogue.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.eleybourn.bookcatalogue.backup;

import java.io.IOException;
import java.io.OutputStream;
import java.util.Date;

/**
 * Interface definition for ant 'books' importer.
 * 
 * Currently (Feb 2013) there is only one, but there will probably be
 * an XML export/import one day.
 * 
 * @author pjw
 */
public interface Exporter {
	/** Flag value to indicate new books and books with more recent update_date fields should be exported */
	public static final int EXPORT_SINCE = 2;
	public static final int EXPORT_PREFERENCES = 4;
	public static final int EXPORT_STYLES = 8;
	public static final int EXPORT_COVERS = 16;
	public static final int EXPORT_DETAILS = 32;
	/** Flag value to indicate ALL books should be exported */
	public static final int EXPORT_ALL = EXPORT_PREFERENCES | EXPORT_STYLES | EXPORT_COVERS | EXPORT_DETAILS;
	public static final int EXPORT_ALL_SINCE = EXPORT_PREFERENCES | EXPORT_STYLES | EXPORT_COVERS | EXPORT_DETAILS | EXPORT_SINCE;
	public static final int EXPORT_MASK = EXPORT_ALL | EXPORT_SINCE;

	/**
	 * Listener interface to get progress messages.
	 * 
	 * @author pjw
	 */
	public interface ExportListener {
		public void setMax(int max);
		public void onProgress(String message, int position);
		public boolean isCancelled();
	}

	/** 
	 * Export function
	 * 
	 * @param outputStream		Stream to send data
	 * @param listener			Progress & cancellation interface
	 * 
	 * @return	true on success
	 * 
	 * @throws IOException
	 */
	public boolean export(OutputStream outputStream, Exporter.ExportListener listener, final int backupFlags, Date since) throws IOException;

}