prajna.geo

Class GeoReader

java.lang.Object

prajna.geo.GeoReader

Direct Known Subclasses:

EsriReader, KmlReader

public abstract class GeoReader
extends java.lang.Object

Abstract class for classes which read Geographic data. Implementations of the GeoReader class should read their data source and store any generated GeoShapes using the addShape() method.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
GeoReader()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addShape(GeoShape shape) Add a shape to the reader's internal shape list.
GeoLayer	createLayer() Creates a geographic layer.
GeoShape	findShape(java.lang.String shapeName) Find a shape which matches the specified shape name.
GeoShape	findShape(java.lang.String fieldName, java.lang.String fieldValue) Find a shape which matches a particular value for a text field.
abstract java.lang.String	getName() Get the name associated with this reader
java.util.List<GeoShape>	getShapes() Gets the geographic shapes.
java.util.Set<GeoShape>	matchShapes(DataFilter filter) Return all shapes which match a particular data filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoReader

public GeoReader()

Method Detail

addShape

protected void addShape(GeoShape shape)

Add a shape to the reader's internal shape list. Any implementing classes should invoke this method when constructing GeoShapes to add the shape to the reader's internal list.

Parameters:

shape - the shape to add

createLayer

public GeoLayer createLayer()

Creates a geographic layer. All shapes currently loaded by this reader will be added to the geographic layer.

Returns:

the new Geographic layer

findShape

public GeoShape findShape(java.lang.String shapeName)

Find a shape which matches the specified shape name. If there are multiple matches, a GeoMultiShape containing all matching shapes is returned.

Parameters:

shapeName - Name of the shape, to match against DBF file data

Returns:

the geoShape corresponding to the name.

findShape

public GeoShape findShape(java.lang.String fieldName,
                 java.lang.String fieldValue)

Find a shape which matches a particular value for a text field. If there are multiple matches, a GeoMultiShape containing all matching shapes is returned.

Parameters:

fieldName - name of the field, to match against DBF file data

fieldValue - value of the field, to match against DBF file data

Returns:

the geoShape corresponding to the name.

getName

public abstract java.lang.String getName()

Get the name associated with this reader

Returns:

the name associated with this reader

getShapes

public java.util.List<GeoShape> getShapes()

Gets the geographic shapes. This returns the series of geographic shapes that this reader has loaded.

Returns:

the list of shapes

matchShapes

public java.util.Set<GeoShape> matchShapes(DataFilter filter)

Return all shapes which match a particular data filter. This method checks the data component for each shape. The set returned contains all of the shapes with data which is accepted by the data filter. If no shapes match, the empty set is returned. This method never returns null.

Parameters:

filter - the data filter to match

Returns:

the set of shapes which match the data filter.