ucar.unidata.gis.shapefile

Class DbaseFile

java.lang.Object

ucar.unidata.gis.shapefile.DbaseFile

public class DbaseFile
extends java.lang.Object

Class to read a dbase file in its entirety.

Author:

Kirk Waters, NOAA Coastal Services Center, 1997., Russ Rew, modified to restrict access to read-only

Field Summary

Fields

Modifier and Type	Field and Description
static int	DBASE5DOS _more_
static int	DBASE5WIN _more_
static int	DBASEIII _more_
static int	DBASEIV _more_

Constructor Summary

Constructors

Constructor and Description
DbaseFile(java.io.File file) Instantiates a new dbase file.
DbaseFile(java.io.InputStream s) Instantiates a new dbase file.
DbaseFile(java.lang.String spec) Instantiates a new dbase file.
DbaseFile(java.net.URL url) Instantiates a new dbase file.

Method Summary

Modifier and Type	Method and Description
boolean[]	getBooleansByName(java.lang.String Name) Extract the boolean array of data for a field by Name.
double[]	getDoublesByName(java.lang.String Name) Extract the double array of data for a field by Name.
DbaseData	getField(int index) Extract the data for a field by field index number.
DbaseData	getField(java.lang.String Name) Extract the data for a given field by name.
java.lang.String	getFieldName(int i) Get the name of a field by column number.
java.lang.String[]	getFieldNames() Get a list of all the field names in the dbase file
int	getNumFields() Get the number of fields in the file.
int	getNumRecords()
java.lang.String[]	getStringsByName(java.lang.String Name) Extract the string array of data for a field by Name.
boolean	isLoaded()
int	loadData() Load the dbase file data.
int	loadHeader() Load the dbase file header.
static void	main(java.lang.String[] args) Test program, dumps a Dbase file to stdout.

Methods inherited from class java.lang.Object

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

Field Detail

DBASEIII

public static int DBASEIII

_more_

DBASEIV

public static int DBASEIV

_more_

DBASE5DOS

public static int DBASE5DOS

_more_

DBASE5WIN

public static int DBASE5WIN

_more_

Constructor Detail

DbaseFile

public DbaseFile(java.net.URL url)
          throws java.net.MalformedURLException,
                 java.io.IOException

Instantiates a new dbase file.

Parameters:

url - URL to the *.dbf file

Throws:

java.net.MalformedURLException - the malformed url exception

java.io.IOException - Signals that an I/O exception has occurred.

DbaseFile

public DbaseFile(java.lang.String spec)
          throws java.io.IOException

Instantiates a new dbase file.

Parameters:

spec - Location of the *.dbf file, as either a URL or filename

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

DbaseFile

public DbaseFile(java.io.File file)

Instantiates a new dbase file.

Parameters:

file - A file object of the *.dbf file.

DbaseFile

public DbaseFile(java.io.InputStream s)

Instantiates a new dbase file.

Parameters:

s - the s

Method Detail

loadHeader

public int loadHeader()

Load the dbase file header.

Returns:

0 for success, -1 for failure

loadData

public int loadData()

Load the dbase file data.

Returns:

0 for success, -1 for failure

getField

public DbaseData getField(int index)

Extract the data for a field by field index number.

Parameters:

index - Column number of the field to extract.

Returns:

A DbaseData object if the column is within bounds. Otherwise, null.

getField

public DbaseData getField(java.lang.String Name)

Extract the data for a given field by name.

Parameters:

Name - String with the name of the field to retrieve.

Returns:

A DbaseData object if the name was found or null if not found

getDoublesByName

public double[] getDoublesByName(java.lang.String Name)

Extract the double array of data for a field by Name.

Parameters:

Name - String with the name of the field to retrieve

Returns:

A double[] if valid numeric field, otherwise null

getStringsByName

public java.lang.String[] getStringsByName(java.lang.String Name)

Extract the string array of data for a field by Name.

Parameters:

Name - String with the name of the field to retrieve

Returns:

A String[] if valid character field, otherwise null

getBooleansByName

public boolean[] getBooleansByName(java.lang.String Name)

Extract the boolean array of data for a field by Name.

Parameters:

Name - String with the name of the field to retrieve

Returns:

A boolean[] if valid character field, otherwise null

getFieldName

public java.lang.String getFieldName(int i)

Get the name of a field by column number.

Parameters:

i - The column number of the field name.

Returns:

A String with the field name or null if out of bounds

getFieldNames

public java.lang.String[] getFieldNames()

Get a list of all the field names in the dbase file

Returns:

A String array of all the field names

getNumFields

public int getNumFields()

Get the number of fields in the file.

Returns:

number of fields

getNumRecords

public int getNumRecords()

Returns:

number of records in the dbase file

isLoaded

public boolean isLoaded()

Returns:

Boolean true if the data has been loaded, otherwise false.

main

public static void main(java.lang.String[] args)

Test program, dumps a Dbase file to stdout.

Parameters:

args - the arguments