org.tinfour.gis.shapefile

Class DbfFieldDate

java.lang.Object

org.tinfour.gis.shapefile.DbfField

org.tinfour.gis.shapefile.DbfFieldDate

public class DbfFieldDate
extends DbfField

Extends DbfField with special handling for reading date values.

Field Summary

Fields inherited from class org.tinfour.gis.shapefile.DbfField

builder, dataAddress, fieldDecimalCount, fieldLength, fieldType, isIntegral, name, numeric, offset

Method Summary

Modifier and Type	Method and Description
Object	getApplicationData() Gets the data for the field as an Object of the appropriate class.
double	getDouble() Gets the value stored in the field during the most recent read as a floating point value giving seconds since the Epoch 1970.
int	getInteger() Gets an integer value indicating whether the data field has been correctly read.
long	getLong() Gets the date value as an long integer time value consistent with the Java convention using Epoch 1970.
ZonedDateTime[]	getUniqueValueArray(DbfFileReader dbf) Gets an array of unique values for this field.
ZonedDateTime	getValue() Gets a ZonedDateTime instance representing the value extracted from the file.
boolean	isNull() Indicates whether the field contains a null value.
void	setZoneOffset(ZoneOffset zoneOffset) Sets the zone offset to be used when reading data

Methods inherited from class org.tinfour.gis.shapefile.DbfField

getFieldDecimalCount, getFieldLength, getFieldType, getLogicalValue, getName, getString, getUniqueValues, isIntegral, isNumeric, toString, usesEngineeringNotation

Methods inherited from class java.lang.Object

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

Method Detail

getDouble

public double getDouble()

Gets the value stored in the field during the most recent read as a floating point value giving seconds since the Epoch 1970.

Overrides:

getDouble in class DbfField

Returns:

a valid double or a NaN if the file content was invalid

getInteger

public int getInteger()

Gets an integer value indicating whether the data field has been correctly read.

Although it would be tempting to make this field return an conventional integer representation of seconds since Epoch 1970, a 32 bit integer value will overflow and become undefined on 03:14:07 UTC on 19 January 2038. If you require an integer time value, please use the getLong() method.

Overrides:

getInteger in class DbfField

Returns:

a value of -1 if the field is uninitialized or zero if it is initialized.

getLong

public long getLong()

Gets the date value as an long integer time value consistent with the Java convention using Epoch 1970.

Returns:

an integer value; zero if undefined.

getApplicationData

public Object getApplicationData()

Description copied from class: DbfField

Gets the data for the field as an Object of the appropriate class. For the DbdField base class, the return value is a string. For others, the return type may vary.

Overrides:

getApplicationData in class DbfField

Returns:

an object, potentially null if the record has not been read.

getValue

public ZonedDateTime getValue()

Gets a ZonedDateTime instance representing the value extracted from the file.

Returns:

a valid local date time.

getUniqueValueArray

public ZonedDateTime[] getUniqueValueArray(DbfFileReader dbf)
                                    throws IOException

Gets an array of unique values for this field.

Parameters:

dbf - a valid instance

Returns:

if successful an array of zero or more elements.

Throws:

IOException - in the event of an unrecoverable I/O condition.

setZoneOffset

public void setZoneOffset(ZoneOffset zoneOffset)

Sets the zone offset to be used when reading data

Parameters:

zoneOffset - a valid instance

isNull

public boolean isNull()

Description copied from class: DbfField

Indicates whether the field contains a null value. Because the interpretation of null fields is not well defined by the DBF file specification, this method should be used with care.

Overrides:

isNull in class DbfField

Returns:

true if the field is empty, otherwise false.