/*
 * Copyright 2010, 2011, 2012 mapsforge.org
 *
 * This program 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.
 *
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program. If not, see <http://www.gnu.org/licenses/>.
 */
package org.mapsforge.map.writer.model;

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

import org.mapsforge.core.model.BoundingBox;
import org.openstreetmap.osmosis.core.domain.v0_6.Node;
import org.openstreetmap.osmosis.core.domain.v0_6.Relation;
import org.openstreetmap.osmosis.core.domain.v0_6.Way;

/**
 * A TileBasedDataStore allows tile based access to OpenStreetMap geo data. POIs and ways are mapped to tiles on
 * configured base zoom levels.
 * 
 * @author bross
 */
public interface TileBasedDataProcessor {
	/**
	 * Get the bounding box that describes this TileBasedDataStore.
	 * 
	 * @return The bounding box that defines the area that is covered by the data store.
	 */
	BoundingBox getBoundingBox();

	/**
	 * Get the layout of a grid on the given zoom interval specification.
	 * 
	 * @param zoomIntervalIndex
	 *            the index of the zoom interval
	 * @return the layout of the grid for the given zoom interval
	 */
	TileGridLayout getTileGridLayout(int zoomIntervalIndex);

	/**
	 * Get the zoom interval configuration of the data store.
	 * 
	 * @return the underlying zoom interval configuration
	 */
	ZoomIntervalConfiguration getZoomIntervalConfiguration();

	/**
	 * Add a node to the data store. No association with a tile is performed.
	 * 
	 * @param node
	 *            the node
	 */
	void addNode(Node node);

	/**
	 * Add a way to the data store.
	 * 
	 * @param way
	 *            the way
	 */
	void addWay(Way way);

	/**
	 * Add a relation to the data store.
	 * 
	 * @param relation
	 *            the relation
	 */
	void addRelation(Relation relation);

	/**
	 * Retrieve the all the inner ways that are associated with an outer way that represents a multipolygon.
	 * 
	 * @param outerWayID
	 *            id of the outer way
	 * @return all associated inner ways
	 */
	List<TDWay> getInnerWaysOfMultipolygon(long outerWayID);

	/**
	 * Retrieves all the data that is associated with a tile.
	 * 
	 * @param baseZoomIndex
	 *            index of the base zoom, as defined in a ZoomIntervalConfiguration
	 * @param tileCoordinateX
	 *            x coordinate of the tile
	 * @param tileCoordinateY
	 *            y coordinate of the tile
	 * @return tile, or null if the tile is outside the bounding box of this tile data store
	 */
	TileData getTile(int baseZoomIndex, int tileCoordinateX, int tileCoordinateY);

	/**
	 * Retrieve the total amount of tiles cumulated over all base zoom levels that is needed to represent the underlying
	 * bounding box of this tile data store.
	 * 
	 * @return total amount of tiles
	 */
	long cumulatedNumberOfTiles();

	/**
	 * Retrieve all coastlines that cross the given tile.
	 * 
	 * @param tc
	 *            the coordinate of the tile
	 * @return all coastlines that cross the tile, an empty set if no coastlines cross
	 */
	Set<TDWay> getCoastLines(TileCoordinate tc);

	/**
	 * Complete the data store, e.g. build indexes or similar.
	 */
	void complete();

	/**
	 * Release all acquired resources, e.g. delete any temporary files.
	 */
	void release();
}