org.geotools.data.vpf.io
Class TableHeader

java.lang.Object
  org.geotools.data.vpf.io.TableHeader

All Implemented Interfaces:

DataTypesDefinition, VPFHeader

public class TableHeader

extends java.lang.Object

implements VPFHeader, DataTypesDefinition

This class contains definition of VPF standard table header according to specification found in: "Interface Standard for Vector Product Format." Objects of this type are immutable. Created: Thu Jan 02 22:50:59 2003

Version:

1.0

Author:

Artur Hefczyc

Field Summary

Fields inherited from interface org.geotools.data.vpf.ifc.DataTypesDefinition

BIG_ENDIAN_ORDER, CHAR_NULL_VALUE, DATA_2_COORD_F, DATA_2_COORD_F_LEN, DATA_2_COORD_R, DATA_2_COORD_R_LEN, DATA_3_COORD_F, DATA_3_COORD_F_LEN, DATA_3_COORD_R, DATA_3_COORD_R_LEN, DATA_DATE_TIME, DATA_DATE_TIME_LEN, DATA_LEVEL1_TEXT, DATA_LEVEL2_TEXT, DATA_LEVEL3_TEXT, DATA_LONG_FLOAT, DATA_LONG_FLOAT_LEN, DATA_LONG_INTEGER, DATA_LONG_INTEGER_LEN, DATA_NULL_FIELD, DATA_NULL_FIELD_LEN, DATA_SHORT_FLOAT, DATA_SHORT_FLOAT_LEN, DATA_SHORT_INTEGER, DATA_SHORT_INTEGER_LEN, DATA_TEXT, DATA_TRIPLET_ID, DATA_TRIPLET_ID_LEN, LEAST_SIGNIF_FIRST, LITTLE_ENDIAN_ORDER, MOST_SIGNIF_FIRST, STRING_NULL_VALUE, STRING_NULL_VALUES

Constructor Summary

TableHeader(int length, char byteOrder, java.lang.String description, java.lang.String narrativeTable, java.util.List columnDefs)
Creates a new TableHeader instance.

Method Summary

char	getByteOrder() Gets the value of byteOrder variable.
java.util.List	getColumnDefs() Gets the value of columnDefs variable keeping definitions of all columns in this table.
java.lang.String	getDescription() Gets the value of the description of table content.
int	getLength() Gets the value of full length of ASCII header string including headerLength field.
java.lang.String	getNarrativeTable() Gets the value of narrativeTable variable file name.
int	getRecordSize() Method getRecordSize is used to return size in bytes of records stored in this table.
java.lang.String	toString() Method toString returns content of all fields values.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableHeader

public TableHeader(int length,
                   char byteOrder,
                   java.lang.String description,
                   java.lang.String narrativeTable,
                   java.util.List columnDefs)

Creates a new TableHeader instance.

Parameters:

length - an int value of table header length.

byteOrder - a char value byte order used in table file.

description - a String value text description of found in header of this table.

narrativeTable - a String value file name of narrative table.

columnDefs - a List value of all column definitions for this table.

Method Detail

toString

public java.lang.String toString()

Method toString returns content of all fields values. Used only for test and debug purpose.

Returns:

a String value

getLength

public int getLength()

Gets the value of full length of ASCII header string including headerLength field.

Specified by:

getLength in interface VPFHeader

Returns:

the value of headerLength

getRecordSize

public int getRecordSize()

Method getRecordSize is used to return size in bytes of records stored in this table. If table keeps variable length records -1 should be returned.

Specified by:

getRecordSize in interface VPFHeader

Returns:

an int value

getByteOrder

public char getByteOrder()

Gets the value of byteOrder variable. Byte order in which table is written:

• L - least-significant-first
• M - most-significant-first

Returns:

the value of byteOrder

getDescription

public java.lang.String getDescription()

Gets the value of the description of table content.

Returns:

the value of description

getNarrativeTable

public java.lang.String getNarrativeTable()

Gets the value of narrativeTable variable file name.

Returns:

the value of narrativeTable

getColumnDefs

public java.util.List getColumnDefs()

Gets the value of columnDefs variable keeping definitions of all columns in this table.

Returns:

the value of columnDefs