ResourceImporter.java

/**
 * eAdventure (formerly <e-Adventure> and <e-Game>) is a research project of the
 *    <e-UCM> research group.
 *
 *    Copyright 2005-2010 <e-UCM> research group.
 *
 *    You can access a list of all the contributors to eAdventure at:
 *          http://e-adventure.e-ucm.es/contributors
 *
 *    <e-UCM> is a research group of the Department of Software Engineering
 *          and Artificial Intelligence at the Complutense University of Madrid
 *          (School of Computer Science).
 *
 *          C Profesor Jose Garcia Santesmases sn,
 *          28040 Madrid (Madrid), Spain.
 *
 *          For more info please visit:  <http://e-adventure.e-ucm.es> or
 *          <http://www.e-ucm.es>
 *
 * ****************************************************************************
 *
 *  This file is part of eAdventure, version 2.0
 *
 *      eAdventure 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 3 of the License, or
 *      (at your option) any later version.
 *
 *      eAdventure 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 eAdventure.  If not, see <http://www.gnu.org/licenses/>.
 */

package ead.importer.interfaces;

import java.awt.Dimension;
import java.awt.image.BufferedImage;
import java.util.List;
import java.util.Map;

import es.eucm.ead.model.interfaces.features.ResourcedEvented;
import es.eucm.ead.model.assets.AssetDescriptor;
import es.eucm.eadventure.common.data.chapter.resources.Resources;
import es.eucm.eadventure.common.loader.InputStreamCreator;

public interface ResourceImporter {

	public static final String DRAWABLE = "drawable";

	public static final String BINARY = "binary";

	/**
	 * Returns the new String for an old resource situated in oldString. It also
	 * copies the old resource to its new location
	 * 
	 * @param oldString
	 *            the old String
	 * @return the new String for the resource. {@code null} it there was any
	 *         problem with the import
	 */
	String getString(String oldString);

	/**
	 * Set the path for the resources importer
	 * 
	 * @param newAdventurePath
	 *            Absolute path where the new adventure must be placed
	 */
	public void setPath(String newAdventurePath);

	void importResources(ResourcedEvented element, List<Resources> resources,
			Map<String, String> resourcesStrings,
			Map<String, Object> resourcesObjectsClasses);

	boolean copyFile(String oldString, String newString);

	/**
	 * Returns an asset descriptor for an old asset path and the class in the
	 * new model
	 * 
	 * @param assetPath
	 *            old asset path
	 * @param clazz
	 *            the class in the new model
	 * @return
	 */
	AssetDescriptor getAssetDescritptor(String assetPath, Class<?> clazz);

	/**
	 * Returns the folder where project is being imported
	 * 
	 * @return
	 */
	String getNewProjecFolder();

	/**
	 * Returns the dimensions for the image in the given old project uri
	 * 
	 * @param oldUri
	 *            the old project image uri
	 * @return the dimensions for the image
	 */
	Dimension getDimensionsForOldImage(String oldUri);

	/**
	 * Returns the dimensions for the image in the given new project uri
	 * 
	 * @param oldUri
	 *            the new project image uri
	 * @return the dimensions for the image
	 */
	Dimension getDimensionsForNewImage(String newUri);

	/**
	 * Loads an image from an old project uri
	 * 
	 * @param oldUri
	 *            the old uri
	 * @return the image
	 */
	BufferedImage getOldImage(String oldUri);

	/**
	 * Loads an image from an old project uri
	 * 
	 * @param oldUri
	 *            the old uri
	 * @return the image
	 */
	BufferedImage getNewImage(String newUri);

	/**
	 * Returns the input stream creator to read files from the old project
	 * 
	 * @return
	 */
	InputStreamCreator getInputStreamCreator();

}