com.kheops.jmap.readers

Class OgrReader

java.lang.Object

com.kheops.jmap.readers.SpatialFileReader

com.kheops.jmap.readers.OgrReader

Direct Known Subclasses:

ArcInfoReader, EdigeoReader, FileGdbReader, GpxReader, KmlReader, TabReader

public class OgrReader
extends SpatialFileReader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OgrReader.OgrAttribute

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Object	GLOBAL_MUTEX

Fields inherited from class com.kheops.jmap.readers.SpatialFileReader

geometryTypesFilter, READER_PARAM_FILES, READER_PARAM_LAYERS

Constructor Summary

Constructors

Constructor and Description
OgrReader()

Method Summary

Modifier and Type	Method and Description
void	close() Frees the resources used by the reader implementation.
Attribute[]	getAttributeMetaData() Gets the metadata associated with the data source.
int	getAvailableGeometryTypes()
protected org.gdal.ogr.Layer	getCurrentLayer()
java.lang.String[]	getLayers() Returns an array of String that defines the layers found in the SpatiaDataSource
java.lang.String	getName()
JMapGeoElement	getNext() Gets the next element from the data source.
java.lang.String	getParametersParserClassName()
java.lang.String[]	getPaths(java.lang.String params) Returns an array of String which defined the file paths used by the reader.
long	getTimeStamp() Gets time stamp of the data file.
java.lang.String	getVersion()
boolean	hasNext() Determines if there are any more information to read using the getNext method.
void	open(java.lang.String params) This method opens the file for the specified layer and sets the its parameters.
void	reset() Resets the state of the reader so that the next call to getNext will return the first element of the data source.

Methods inherited from class com.kheops.jmap.readers.SpatialFileReader

getGeometryTypesFilter, getNextColunmName, isColunmNameExists, loadReader, setGeometryTypesFilter, validateMetaData

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_MUTEX

protected static final java.lang.Object GLOBAL_MUTEX

Constructor Detail

OgrReader

public OgrReader()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class SpatialFileReader

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in class SpatialFileReader

getParametersParserClassName

public java.lang.String getParametersParserClassName()

Specified by:

getParametersParserClassName in class SpatialFileReader

open

public void open(java.lang.String params)
          throws java.lang.Exception

This method opens the file for the specified layer and sets the its parameters.

Specified by:

open in class SpatialFileReader

Parameters:

params - the string containing the parameters for the layer.

Throws:

java.lang.Exception

getCurrentLayer

protected org.gdal.ogr.Layer getCurrentLayer()

getNext

public JMapGeoElement getNext()
                       throws java.lang.Exception

Gets the next element from the data source. Availability should be checked first using method hasNext.

Specified by:

getNext in class SpatialFileReader

Returns:

the next JMapGeoElement object

Throws:

java.lang.Exception

See Also:

SpatialFileReader.hasNext(), SpatialFileReader.reset(), JMapGeoElement

hasNext

public boolean hasNext()
                throws java.lang.Exception

Determines if there are any more information to read using the getNext method.

Specified by:

hasNext in class SpatialFileReader

Returns:

true if there is at least one more element to read, false otherwise

Throws:

java.lang.Exception

See Also:

SpatialFileReader.getNext(), SpatialFileReader.reset()

getAttributeMetaData

public Attribute[] getAttributeMetaData()
                                 throws java.lang.Exception

Gets the metadata associated with the data source. The metadata provides information about the descriptive data columns bound to the geometrical data of the data source. N.B: This method has to take care of possible duplicate attribute name.

Specified by:

getAttributeMetaData in class SpatialFileReader

Returns:

an array of Attribute instance.

Throws:

java.lang.Exception

See Also:

Attribute

getPaths

public java.lang.String[] getPaths(java.lang.String params)

Returns an array of String which defined the file paths used by the reader.

Specified by:

getPaths in class SpatialFileReader

Parameters:

params - the parameters used to open the SpatialFileDatasource

Returns:

the file paths used by the reader.

getLayers

public java.lang.String[] getLayers()
                             throws java.lang.Exception

Returns an array of String that defines the layers found in the SpatiaDataSource

Specified by:

getLayers in class SpatialFileReader

Returns:

an array of String or null if the SpatiaDataSource doesn't support layers

Throws:

java.lang.Exception

getAvailableGeometryTypes

public int getAvailableGeometryTypes()
                              throws java.lang.Exception

Specified by:

getAvailableGeometryTypes in class SpatialFileReader

Throws:

java.lang.Exception

getTimeStamp

public long getTimeStamp()
                  throws java.lang.Exception

Gets time stamp of the data file. This time stamp can be used to determine if the data has changed since it was last accessed.

Specified by:

getTimeStamp in class SpatialFileReader

Returns:

the time stamp (number of milliseconds since Jan. 1st 1970) of the data file or -1 if not supported by the implementation of the reader

Throws:

java.lang.Exception

close

public void close()
           throws java.lang.Exception

Frees the resources used by the reader implementation. Some implementations require that this method be called after use while other implementations don't.

Specified by:

close in class SpatialFileReader

Throws:

java.lang.Exception

reset

public void reset()
           throws java.lang.Exception

Resets the state of the reader so that the next call to getNext will return the first element of the data source.

Specified by:

reset in class SpatialFileReader

Throws:

java.lang.Exception