org.geoserver.catalog.DataStoreInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of main
The newest version!
/* Copyright (c) 2001 - 2008 TOPP - www.openplans.org. All rights reserved.
 * This code is licensed under the GPL 2.0 license, available at the root
 * application directory.
 */
package org.geoserver.catalog;

import java.io.IOException;
import java.io.Serializable;
import java.util.Iterator;
import java.util.Map;

import org.geotools.data.DataStore;
import org.opengis.util.ProgressListener;

/**
 * A vector or feature based store.
 * 
 * @author Justin Deoliveira, The Open Planning project
 */
public interface DataStoreInfo extends StoreInfo {

 /**
     * Returns the underlying datastore instance.
     * 
     * This method does I/O and is potentially blocking. The listener
     * may be used to report the progress of loading the datastore and also to
     * report any errors or warnings that occur.
     * 
     * 
     * @param listener
     *                A progress listener, may be null.
     * 
     * @return The datastore.
     * 
     * @throws IOException
     *                 Any I/O problems.
     */
    DataStore getDataStore(ProgressListener listener) throws IOException;

    /**
     * DataStoreInfo equality is based on the following properties:
     * 
     *   {@link StoreInfo#getId()}
     *   
{@link StoreInfo#getName()}
     *   
{@link StoreInfo#getDescription()}
     *   
{@link StoreInfo#getNamespace()}
     *   
{@link StoreInfo#isEnabled()}
     *   
{@link DataStoreInfo#getConnectionParameters()}
     * 
     * 
     */
    boolean equals(Object obj);
    
    /**
     * Returns the feature resource from the store with the given name.
     * 
     * listener is used to report the progress of finding the
     * resource.
     * 
     * 
     * @throws IOException
     *                 Any I/O problems.
     */
    //FeatureResource getResource(String name, ProgressListener listener)
    //        throws IOException;
    
    /**
     * Returns the feature resources provided by the store.
     */
    //Iterator getResources(ProgressListener monitor)
    //    throws IOException;
}