EditorModel.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 es.eucm.ead.editor.model;

import es.eucm.ead.editor.EditorStringHandler;
import es.eucm.ead.editor.model.nodes.DependencyNode;
import es.eucm.ead.editor.view.dock.ModelAccessor;
import es.eucm.ead.model.elements.AdventureGame;

import java.util.HashMap;
import java.util.List;
import java.util.Set;

/**
 * Contains a full model of what is being edited. This is a super-set of an
 * AdventureGame, encompassing both engine-related model objects and
 * resources, assets, and strings. Everything is searchable, and dependencies
 * are tracked as objects are changed.
 *
 * @author mfreire
 */
public interface EditorModel extends ModelAccessor {

	// -------- nodes

	DependencyNode getNode(int id);

	DependencyNode getNodeFor(Object content);

	int getEditorId(Object o);

	int generateId(Object targetObject);

	List<DependencyNode> incomingDependencies(DependencyNode node);

	List<DependencyNode> outgoingDependencies(DependencyNode node);

	/**
	 * Updates incoming and outgoing dependencies for a set of nodes.
	 * @param changed existing nodes that have had their edges changed
	 *     are placed here.
	 * @param added nodes that have been added (discovered through edge-traversal)
	 *	   are placed here.
	 * @param nodes to update
	 */
	void updateDependencies(Set<DependencyNode> changed,
			Set<DependencyNode> added, DependencyNode... nodes);

	// -------- search

	ModelIndex.SearchResult search(ModelQuery query);

	// -------- saving, loading, and engine-model access

	AdventureGame getEngineModel();

	EditorStringHandler getStringHandler();

	HashMap<String, String> getEngineProperties();

	/**
	 * The loader is in charge of importing, loading and saving games.
	 * @return
	 */
	EditorModelLoader getLoader();

	// -------- progress updates (when saving, loading, ...)

	void addProgressListener(ModelProgressListener progressListener);

	void removeProgressListener(ModelProgressListener progressListener);

	/**
	 * A very simple interface for progress updates
	 */
	public static interface ModelProgressListener {
		/**
		 * Called whenever progress is made.
		 * @param progress from 0 to 100
		 * @param text to display regarding progress
		 */
		public void update(int progress, String text);
	}

	// -------- model changes (nodes added, changed, removed)

	void addModelListener(ModelListener modelListener);

	void removeModelListener(ModelListener modelListener);

	/**
	 * Delivers the modelEvent to all registered listeners. Any changes
	 * described must already have been performed. Intended to be called
	 * by Commands or similar change-encapsulating constructs.
	 * @param event describing the changes.
	 */
	void fireModelEvent(ModelEvent event);

	/**
	 * A very simple interface for progress updates
	 */
	public static interface ModelListener {
		/**
		 * Called whenever parts of the model change.
		 * @param event describing the change
		 */
		public void modelChanged(ModelEvent event);
	}
}