oracle.spatial.hadoop.vector.shapefile

Class DBFReader

java.lang.Object

oracle.spatial.hadoop.vector.shapefile.DBFReader

public class DBFReader
extends java.lang.Object

DBF files reader. Optionally CPG files can be specified to define the encoding.

Author:

rinfante

Constructor Summary

Constructors

Constructor and Description
DBFReader(java.io.InputStream inputStream) Construct an object out of the specified shapefile's DBF file input stream.
DBFReader(java.io.InputStream inputStream, java.io.InputStream cpgFileInputStream) Construct an object out of the specified shapefile's DBF file input stream and of the optional CPG file input stream.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFieldData(int ith, byte[] rec) Returns the value string for the ith field in the given record.
java.lang.String	getFieldName(int ith) Returns the name for the ith field of records in this file.
byte	getFieldType(int ith) Returns the type for the ith field in a record.
byte[]	getRecord(int nth) Retrieves the nth record in the file.
int	numFields() Returns the number of fields in each record.
int	numRecords() Returns the number of records in the DBF file.
void	print() nicely print out the general information of this DBF file.
int	recordSize() Returns the record size in the DBF file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBFReader

public DBFReader(java.io.InputStream inputStream)
          throws java.io.IOException

Construct an object out of the specified shapefile's DBF file input stream.

Parameters:

inputStream - the DBF file input stream

Throws:

java.io.IOException - thrown if an IOException occurs

DBFReader

public DBFReader(java.io.InputStream inputStream,
                 java.io.InputStream cpgFileInputStream)
          throws java.io.IOException

Construct an object out of the specified shapefile's DBF file input stream and of the optional CPG file input stream.

Parameters:

inputStream - the DBF file input stream

cpgFileInputStream - the CPG file input stream

Throws:

java.io.IOException - thrown if an IOException occurs

Method Detail

getFieldData

public java.lang.String getFieldData(int ith,
                                     byte[] rec)

Returns the value string for the ith field in the given record. Returns null is returned if something is wrong (e.g., invalid field index). If the .cpg file is available then the method transform the string from the original encoding to UTF-8.

Parameters:

ith - the number of the field

rec - records bytes

Returns:

the value string for the ith field in the given record

getFieldName

public java.lang.String getFieldName(int ith)

Returns the name for the ith field of records in this file.

Parameters:

ith - the number of the field

Returns:

the name for the ith field of records in this file

getFieldType

public byte getFieldType(int ith)

Returns the type for the ith field in a record. returns a single character the meaning of which is defined as below:

        'C': character
        'D': Date (8 digits: YYYYMMDD)
        'F': Floating point binary numeric: -. 0 1 2 3 4 5 6 7 8 9
        'G': General. All OEM characters or OLE.
        'L': Logical: ? Y y N  n T t F f (? initially)
        'M': Memo
        'N': Float: - . 0 1 2 3 4 5 6 7 8 9
        'I': Integer: - 0 1 2 3 4 5 6 7 8 9
 

Parameters:

ith - the number of the field

Returns:

the type for the ith field in a record

getRecord

public byte[] getRecord(int nth)

Retrieves the nth record in the file. Return the record in bytes.

Parameters:

nth - record number in the file

Returns:

the record in bytes

numFields

public int numFields()

Returns the number of fields in each record.

Returns:

the number of fields in each record

numRecords

public int numRecords()

Returns the number of records in the DBF file.

Returns:

the number of records in the DBF file.

print

public void print()

nicely print out the general information of this DBF file.

recordSize

public int recordSize()

Returns the record size in the DBF file.

Returns:

the record size in the DBF file