org.gvsig.gdal.prov.ogr

Class OGRDataExplorer

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.spi.AbstractDataServerExplorer

org.gvsig.gdal.prov.ogr.OGRDataExplorer

All Implemented Interfaces:

DataFactoryUnit, DataServerExplorer, DataServerExplorer_v2, ResourceConsumer, DataServerExplorerProvider, Disposable

Direct Known Subclasses:

GMLDataExplorer

public class OGRDataExplorer
extends AbstractDataServerExplorer
implements DataServerExplorerProvider, ResourceConsumer

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSource	dataSource
static String	NAME
protected OGRDataExplorerParameters	parameters
protected Boolean	updateSupport

Fields inherited from interface org.gvsig.fmap.dal.DataServerExplorer

MODE_ALL, MODE_FEATURE, MODE_GEOMETRY, MODE_RASTER

Constructor Summary

Constructors

Constructor and Description
OGRDataExplorer(OGRDataExplorerParameters parameters, DataServerExplorerProviderServices providerServices)

Method Summary

Modifier and Type	Method and Description
boolean	add(String provider, NewDataStoreParameters parameters, boolean overwrite) Creates a new DataStore in this server.
boolean	canAdd() Indicates whether this DataServerExplorer can create a new DataStore in the server.
boolean	canAdd(String storeName) Indicates whether this DataServerExplorer can create a new DataStore in the server, given the store name.
boolean	closeResourceRequested(ResourceProvider resource)
void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
DataStoreParameters	get(String name)
NewDataStoreParameters	getAddParameters(String storeName) Given the store's name, returns its parameters for creation.
protected DataSource	getDataSource()
List	getDataStoreProviderNames() Return the list of provider names that this server allow.
protected List<Layer>	getLayerList()
DataServerExplorerParameters	getParameters() Returns this DataServerExplorer parameters
String	getProviderName() Returns the DataServerExplorer's name
DataServerExplorerProviderServices	getServerExplorerProviderServices()
List	list() Provides a list of available stores in the server.
List	list(int mode) Provides a list of available stores in the server of a type.
void	remove(DataStoreParameters parameters) Removes a store from the server given its DataStoreParameters.
void	resourceChanged(ResourceProvider resource)

Methods inherited from class org.gvsig.fmap.dal.spi.AbstractDataServerExplorer

createSQLBuilder, getResourcePath

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

dispose, dispose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gvsig.fmap.dal.DataServerExplorer

getResourcePath

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

parameters

protected OGRDataExplorerParameters parameters

dataSource

protected DataSource dataSource

updateSupport

protected Boolean updateSupport

Constructor Detail

OGRDataExplorer

public OGRDataExplorer(OGRDataExplorerParameters parameters,
                       DataServerExplorerProviderServices providerServices)
                throws InitializeException

Parameters:

parameters - Parameters to open data explorer.

providerServices - Available services

Throws:

InitializeException - If there is some error initializing this store provider

Method Detail

getDataSource

protected DataSource getDataSource()
                            throws OGRUnsupportedFormatException

Throws:

OGRUnsupportedFormatException

getLayerList

protected List<Layer> getLayerList()

getProviderName

public String getProviderName()

Description copied from interface: DataServerExplorer

Returns the DataServerExplorer's name

Specified by:

getProviderName in interface DataServerExplorer

Returns:

String containing this DataServerExplorer's name

canAdd

public boolean canAdd()

Description copied from interface: DataServerExplorer

Indicates whether this DataServerExplorer can create a new DataStore in the server.

Specified by:

canAdd in interface DataServerExplorer

Returns:

true if this DataServerExplorer can be created or false otherwise.

canAdd

public boolean canAdd(String storeName)
               throws DataException

Description copied from interface: DataServerExplorer

Indicates whether this DataServerExplorer can create a new DataStore in the server, given the store name.

Specified by:

canAdd in interface DataServerExplorer

Parameters:

storeName - store name.

Returns:

true if this DataServerExplorer can create a new store or false otherwise.

Throws:

DataException

list

public List list()
          throws DataException

Description copied from interface: DataServerExplorer

Provides a list of available stores in the server.

Specified by:

list in interface DataServerExplorer

Returns:

list of DataStoreParameters

Throws:

DataException

list

public List list(int mode)
          throws DataException

Description copied from interface: DataServerExplorer

Provides a list of available stores in the server of a type.

Specified by:

list in interface DataServerExplorer

Parameters:

mode - , filter store from a type: DataServerExplorer.MODE_ALL, DataServerExplorer.MODE_FEATURE, #MODE_FEATURE_GEOMETRY, DataServerExplorer.MODE_RASTER

Returns:

list of DataStoreParameters

Throws:

DataException

add

public boolean add(String provider,
                   NewDataStoreParameters parameters,
                   boolean overwrite)
            throws DataException

Description copied from interface: DataServerExplorer

Creates a new DataStore in this server.

Specified by:

add in interface DataServerExplorer

parameters - , an instance of DataStoreParameters from DataServerExplorer.getAddParameters(String) that describes the new DataStore.

overwrite - if the store already exists

Returns:

true if the DataStoreParameters were successfully added, false otherwise.

Throws:

DataException

remove

public void remove(DataStoreParameters parameters)
            throws DataException

Description copied from interface: DataServerExplorer

Removes a store from the server given its DataStoreParameters. If the store is a file then this method deletes the file, if it is a table in a database then this method drops the table, and so on.

Specified by:

remove in interface DataServerExplorer

Throws:

DataException

getAddParameters

public NewDataStoreParameters getAddParameters(String storeName)
                                        throws DataException

Description copied from interface: DataServerExplorer

Given the store's name, returns its parameters for creation.

Specified by:

getAddParameters in interface DataServerExplorer

Returns:

parameters to create a store

Throws:

DataException

getParameters

public DataServerExplorerParameters getParameters()

Description copied from interface: DataServerExplorer

Returns this DataServerExplorer parameters

Specified by:

getParameters in interface DataServerExplorer

Overrides:

getParameters in class AbstractDataServerExplorer

Returns:

an instance of DataServerExplorerParameters containing this DataServerExplorer parameters.

getDataStoreProviderNames

public List getDataStoreProviderNames()

Description copied from interface: DataServerExplorer

Return the list of provider names that this server allow.

Specified by:

getDataStoreProviderNames in interface DataServerExplorer

Returns:

List of provider names

doDispose

public void doDispose()

Description copied from class: AbstractDisposable

Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.

Overrides:

doDispose in class AbstractDataServerExplorer

See Also:

AbstractDisposable.dispose()

getServerExplorerProviderServices

public DataServerExplorerProviderServices getServerExplorerProviderServices()

Specified by:

getServerExplorerProviderServices in interface DataServerExplorerProvider

Overrides:

getServerExplorerProviderServices in class AbstractDataServerExplorer

closeResourceRequested

public boolean closeResourceRequested(ResourceProvider resource)

Specified by:

closeResourceRequested in interface ResourceConsumer

resourceChanged

public void resourceChanged(ResourceProvider resource)

Specified by:

resourceChanged in interface ResourceConsumer

get

public DataStoreParameters get(String name)
                        throws DataException

Specified by:

get in interface DataServerExplorer

Overrides:

get in class AbstractDataServerExplorer

Throws:

DataException