Package org.geotools.data.vpf.io
Class TableHeader
- Object
-
- TableHeader
-
- All Implemented Interfaces:
DataTypesDefinition
,VPFHeader
public class TableHeader extends 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- Author:
- Artur Hefczyc
-
-
Field Summary
-
Fields inherited from interface 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
Constructors Constructor Description TableHeader(int length, char byteOrder, String description, String narrativeTable, List<TableColumnDef> columnDefs)
Creates a newTableHeader
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description char
getByteOrder()
Gets the value of byteOrder variable.List<TableColumnDef>
getColumnDefs()
Gets the value of columnDefs variable keeping definitions of all columns in this table.String
getDescription()
Gets the value of the description of table content.int
getLength()
Gets the value of full length of ASCII header string includingheaderLength
field.String
getNarrativeTable()
Gets the value of narrativeTable variable file name.int
getRecordSize()
Method
is used to return size in bytes of records stored in this table.getRecordSize
String
toString()
MethodtoString
returns content of all fields values.
-
-
-
Constructor Detail
-
TableHeader
public TableHeader(int length, char byteOrder, String description, String narrativeTable, List<TableColumnDef> columnDefs)
Creates a newTableHeader
instance.- Parameters:
length
- anint
value of table header length.byteOrder
- achar
value byte order used in table file.description
- aString
value text description of found in header of this table.narrativeTable
- aString
value file name of narrative table.columnDefs
- aList
value of all column definitions for this table.
-
-
Method Detail
-
toString
public String toString()
MethodtoString
returns content of all fields values. Used only for test and debug purpose.
-
getLength
public int getLength()
Gets the value of full length of ASCII header string includingheaderLength
field.
-
getRecordSize
public int getRecordSize()
Method
is used to return size in bytes of records stored in this table. If table keeps variable length recordsgetRecordSize
-1
should be returned.- Specified by:
getRecordSize
in interfaceVPFHeader
- Returns:
- an
valueint
-
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 String getDescription()
Gets the value of the description of table content.- Returns:
- the value of description
-
getNarrativeTable
public String getNarrativeTable()
Gets the value of narrativeTable variable file name.- Returns:
- the value of narrativeTable
-
getColumnDefs
public List<TableColumnDef> getColumnDefs()
Gets the value of columnDefs variable keeping definitions of all columns in this table.- Returns:
- the value of columnDefs
-
-