/*$************************************************************************************************
**
** $Id: LayerSource.java 831 2006-05-01 00:27:23Z Desruisseaux $
**
** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/layer/source/LayerSource.java $
**
** Copyright (C) 2005 Open GIS Consortium, Inc.
** All Rights Reserved. http://www.opengis.org/legal/
**
*************************************************************************************************/
package org.opengis.layer.source;
// J2SE direct dependencies
import java.io.IOException;
import java.net.URI;
import java.util.List;
// OpenGIS direct dependencies
import org.opengis.feature.Feature;
import org.opengis.feature.FeatureStore;
import org.opengis.feature.display.canvas.FeatureLayer;
import org.opengis.filter.Filter;
import org.opengis.layer.Layer;
import org.opengis.layer.LayerException;
import org.opengis.util.InternationalString;
/**
* Provides {@link Layer}s to a manager.
* {@code Layer}s are the base unit in a Table of Contents, which could be used to provide
* a human-readable visualization of the data available to add to a rendered visualization.
* A {@code LayerSource} could be capable of retrieving {@linkplain Feature features} from
* given {@linkplain FeatureStore feature stores} using a given {@linkplain Filter filter}
* and creating the necessary {@linkplain FeatureLayer feature layer}. Other
* {@code LayerSource} implementations may connect to some other data source and produce
* {@linkplain org.opengis.go.display.primitive.Graphic graphics} to be owned by the produced
* {@linkplain Layer layers}.
*
* @author Jesse Crossley (SYS Technologies)
* @since GeoAPI 2.0
*/
public interface LayerSource {
/**
* Icon representing this type of LayerSource.
*
* @return URI to a icon (GIF or PNG) representing this layer source.
*/
URI getIcon();
/**
* Display name used to communicate this {@code LayerSource} to end users.
*/
InternationalString getDisplayName();
/**
* Description of this type of {@code LayerSource}.
*/
InternationalString getDescription();
/**
* Gets the named {@code Layer}.
*
* @param name the id of the {@code Layer}.
* @throws IOException if there is an IO problem getting the named {@code Layer}
* @throws LayerException if there is any other problem getting the named {@code Layer}
*/
Layer getLayer(String name) throws IOException, LayerException;
/**
* Returns a List of {@code Layer}s provided by this {@code LayerSource}.
* This List should not be a live List: modifying the returned List
* (if modifiable) should not modify this {@code LayerSource}'s {@code Layer}s.
*
* @return a List of {@code Layer}s
* @throws IOException if there is an IO problem getting the {@code Layer}s
* @throws LayerException if there is any other problem getting the named {@code Layer}
*/
List getLayers() throws IOException, LayerException;
}
Ads help maintain this website.