ucar.visad

Class ShapefileForm

java.lang.Object

visad.data.FormNode

visad.data.Form

ucar.visad.ShapefileForm

All Implemented Interfaces:

visad.data.FormFileInformer

public class ShapefileForm
extends visad.data.Form
implements visad.data.FormFileInformer

ShapefileForm is the shapefile data format adapter for ESRI shapefile maps.

Version:

$Revision: 1.8 $ $Date: 2007/03/22 10:53:50 $

Author:

Don Murray

Field Summary

Fields inherited from class visad.data.Form

mathType

Constructor Summary

Constructors

Constructor and Description
ShapefileForm() Construct a Form for reading in ESRI shapefile map files

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String id, visad.Data data, boolean replace) Add data to an existing data object
java.lang.String[]	getDefaultSuffixes() Get a list of default suffixes for shapfile map files
visad.data.FormNode	getForms(visad.Data data) Return the data forms that are compatible with a data object
boolean	isThisType(byte[] block) Determines if this is a shapfile map file from the starting block
boolean	isThisType(java.lang.String name) Determines if this is a shapefile map file from the name
visad.DataImpl	open(java.lang.String id) Open the file specified by the string
visad.DataImpl	open(java.net.URL url) Open the file specified by the URL
void	save(java.lang.String id, visad.Data data, boolean replace) Save a VisAD data object in this form

Methods inherited from class visad.data.Form

getMathType

Methods inherited from class visad.data.FormNode

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

ShapefileForm

public ShapefileForm()

Construct a Form for reading in ESRI shapefile map files

Method Detail

isThisType

public boolean isThisType(java.lang.String name)

Determines if this is a shapefile map file from the name

Specified by:

isThisType in interface visad.data.FormFileInformer

Parameters:

name - name of the file

Returns:

true if it matches the pattern for shapefile map files

isThisType

public boolean isThisType(byte[] block)

Determines if this is a shapfile map file from the starting block

Specified by:

isThisType in interface visad.data.FormFileInformer

Parameters:

block - block of data to check

Returns:

false - there is no identifying block in a Shapefile map file

getDefaultSuffixes

public java.lang.String[] getDefaultSuffixes()

Get a list of default suffixes for shapfile map files

Specified by:

getDefaultSuffixes in interface visad.data.FormFileInformer

Returns:

valid list of suffixes

save

public void save(java.lang.String id,
                 visad.Data data,
                 boolean replace)
          throws visad.data.BadFormException,
                 java.io.IOException,
                 java.rmi.RemoteException,
                 visad.VisADException

Save a VisAD data object in this form

Specified by:

save in class visad.data.FormNode

Parameters:

id - location of data

data - data to add

replace - true to replace old with new

Throws:

visad.data.BadFormException - bad form

java.io.IOException - file doesn't exist

java.rmi.RemoteException - Java RMI problem

visad.VisADException - Problem creating data. throws UnimplementedException - can't be done yet.

add

public void add(java.lang.String id,
                visad.Data data,
                boolean replace)
         throws visad.data.BadFormException

Add data to an existing data object

Specified by:

add in class visad.data.FormNode

Parameters:

id - location of data

data - data to add

replace - true to replace old with new

Throws:

visad.data.BadFormException - always for this form

open

public visad.DataImpl open(java.lang.String id)
                    throws visad.data.BadFormException,
                           java.io.IOException,
                           visad.VisADException

Open the file specified by the string

Specified by:

open in class visad.data.FormNode

Parameters:

id - string representing the path to the file

Returns:

a Data object representing the map lines.

Throws:

visad.data.BadFormException - bad form

java.io.IOException - file doesn't exist

visad.VisADException - Problem creating data

open

public visad.DataImpl open(java.net.URL url)
                    throws visad.data.BadFormException,
                           visad.VisADException,
                           java.io.IOException

Open the file specified by the URL

Specified by:

open in class visad.data.FormNode

Parameters:

url - URL of the remote map

Returns:

a Data object representing the map lines.

Throws:

visad.data.BadFormException - bad form

java.io.IOException - file doesn't exist

visad.VisADException - Problem creating data

getForms

public visad.data.FormNode getForms(visad.Data data)

Return the data forms that are compatible with a data object

Specified by:

getForms in class visad.data.FormNode

Parameters:

data - data in question

Returns:

null