Class 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
    Artur Hefczyc
    • Constructor Detail

      • TableHeader

        public TableHeader​(int length,
                           char byteOrder,
                           String description,
                           String narrativeTable,
                           List<TableColumnDef> columnDefs)
        Creates a new TableHeader instance.
        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 String toString()
        Method toString returns content of all fields values. Used only for test and debug purpose.
        toString in class Object
        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
        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
        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
        the value of byteOrder
      • getDescription

        public String getDescription()
        Gets the value of the description of table content.
        the value of description
      • getNarrativeTable

        public String getNarrativeTable()
        Gets the value of narrativeTable variable file name.
        the value of narrativeTable
      • getColumnDefs

        public List<TableColumnDef> getColumnDefs()
        Gets the value of columnDefs variable keeping definitions of all columns in this table.
        the value of columnDefs