AbstractColumnInfo (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.maps.defense.format.vmap.AbstractColumnInfo

```
public abstract class AbstractColumnInfo
extends Object
```
Abstract class that encapsulates the definition of a column in a VMAP table. Subclasses must implement the actual method to read the appropriate field from a specified stream.

Since:

JViews 8.1

Version:

1.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DATE_TIME_TYPE` Date and Time : D
`static String`	`LEVEL_1_TEXT_TYPE` Level 1 (Latin 1 - ISO 8859) Fixed-length text : L,n Level 1 (Latin 1 - ISO 8859) Variable-length text : L,*
`static String`	`LEVEL_2_TEXT_TYPE` Level 2 (Full Latin - ISO 6937) Fixed-length text : N,n Level 2 (Full Latin - ISO 6937) Variable-length text : N,*
`static String`	`LEVEL_3_TEXT_TYPE` Level 3 (Multilingual - ISO 10646) Fixed-length text : M,n Level 3 (Multilingual - ISO 10646) Variable-length text : M,*
`static String`	`LONG_FLOATING_POINT_TYPE` Long floating point : R
`static String`	`LONG_INTEGER_TYPE` Long integer : I
`static String`	`NULL_FIELD_TYPE` Null field : X
`static String`	`SHORT_FLOATING_POINT_TYPE` Short floating point : F
`static String`	`SHORT_INTEGER_TYPE` Short Integer : S
`static String`	`TEXT_TYPE` Fixed-length text : T,n Variable-length text :T,*
`static String`	`THREE_COORDINATE_LONG_FLOATING_POINT_TYPE` 3-coordinate array long floating point : Y,n 3-coordinate string long floating point : Y,*
`static String`	`THREE_COORDINATE_SHORT_FLOATING_POINT_TYPE` 3-coordinate array short floating point : Z,n 3-coordinate string short floating point : Z,*
`static String`	`TRIPLET_ID_TYPE` Triplet id : K
`static String`	`TWO_COORDINATE_LONG_FLOATING_POINT_TYPE` 2-coordinate array long floating point : B,n 2-coordinate string long floating point : B,*
`static String`	`TWO_COORDINATE_SHORT_FLOATING_POINT_TYPE` 2-coordinate array short floating point : C,n 2-coordinate string short floating point : C,*

Constructor Summary

Constructors
Constructor and Description
`AbstractColumnInfo(String columnName, String dataType, int numberOfElements, String keyType, String columnDescription, String valueDescriptionTable, String thematicIndexFile, String documentationFileName, IlvVMAPTable associatedTable)` Public constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`IlvVMAPTable`	`getAssociatedTable()` Returns the VMAP table to which this AbstractColumnInfo belongs.
`String`	`getColumnDescription()` Returns the description of this column.
`String`	`getDocumentationFileName()` Returns associated documentation file name.
`abstract Class<?>`	`getFieldClass()` Return the actual Class of the field associated with this column.
`abstract int`	`getFieldLength()` Returns the length of the field associated with this class (-1 if variable length field).
`String`	`getFieldType()` Returns the type of the field described by this column.
`String`	`getKeyType()` Returns the type of key held by this column (primary, unique, non unique).
`String`	`getName()` Returns the name of this column.
`int`	`getNumberOfElements()` Return the number of elements (of the specified type) in a field of this column (-1 if variable length field).
`String`	`getThematicIndexFile()` Returns associated thematic index file name.
`String`	`getValueDescriptionTable()` Returns associated value table description file name.
`abstract Object`	`parseField(IlvVMAPDataInput VMAPDataInput)` Parse appropriate data on the specified stream for this column type (implemented by concrete subclasses).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TEXT_TYPE
```
public static final String TEXT_TYPE
```
    Fixed-length text : T,n Variable-length text :T,*
    
    See Also:
    
    Constant Field Values
  - LEVEL_1_TEXT_TYPE
```
public static final String LEVEL_1_TEXT_TYPE
```
    Level 1 (Latin 1 - ISO 8859) Fixed-length text : L,n Level 1 (Latin 1 - ISO 8859) Variable-length text : L,*
    
    See Also:
    
    Constant Field Values
  - LEVEL_2_TEXT_TYPE
```
public static final String LEVEL_2_TEXT_TYPE
```
    Level 2 (Full Latin - ISO 6937) Fixed-length text : N,n Level 2 (Full Latin - ISO 6937) Variable-length text : N,*
    
    See Also:
    
    Constant Field Values
  - LEVEL_3_TEXT_TYPE
```
public static final String LEVEL_3_TEXT_TYPE
```
    Level 3 (Multilingual - ISO 10646) Fixed-length text : M,n Level 3 (Multilingual - ISO 10646) Variable-length text : M,*
    
    See Also:
    
    Constant Field Values
  - SHORT_FLOATING_POINT_TYPE
```
public static final String SHORT_FLOATING_POINT_TYPE
```
    Short floating point : F
    
    See Also:
    
    Constant Field Values
  - LONG_FLOATING_POINT_TYPE
```
public static final String LONG_FLOATING_POINT_TYPE
```
    Long floating point : R
    
    See Also:
    
    Constant Field Values
  - SHORT_INTEGER_TYPE
```
public static final String SHORT_INTEGER_TYPE
```
    Short Integer : S
    
    See Also:
    
    Constant Field Values
  - LONG_INTEGER_TYPE
```
public static final String LONG_INTEGER_TYPE
```
    Long integer : I
    
    See Also:
    
    Constant Field Values
  - TWO_COORDINATE_SHORT_FLOATING_POINT_TYPE
```
public static final String TWO_COORDINATE_SHORT_FLOATING_POINT_TYPE
```
    2-coordinate array short floating point : C,n 2-coordinate string short floating point : C,*
    
    See Also:
    
    Constant Field Values
  - TWO_COORDINATE_LONG_FLOATING_POINT_TYPE
```
public static final String TWO_COORDINATE_LONG_FLOATING_POINT_TYPE
```
    2-coordinate array long floating point : B,n 2-coordinate string long floating point : B,*
    
    See Also:
    
    Constant Field Values
  - THREE_COORDINATE_SHORT_FLOATING_POINT_TYPE
```
public static final String THREE_COORDINATE_SHORT_FLOATING_POINT_TYPE
```
    3-coordinate array short floating point : Z,n 3-coordinate string short floating point : Z,*
    
    See Also:
    
    Constant Field Values
  - THREE_COORDINATE_LONG_FLOATING_POINT_TYPE
```
public static final String THREE_COORDINATE_LONG_FLOATING_POINT_TYPE
```
    3-coordinate array long floating point : Y,n 3-coordinate string long floating point : Y,*
    
    See Also:
    
    Constant Field Values
  - DATE_TIME_TYPE
```
public static final String DATE_TIME_TYPE
```
    Date and Time : D
    
    See Also:
    
    Constant Field Values
  - NULL_FIELD_TYPE
```
public static final String NULL_FIELD_TYPE
```
    Null field : X
    
    See Also:
    
    Constant Field Values
  - TRIPLET_ID_TYPE
```
public static final String TRIPLET_ID_TYPE
```
    Triplet id : K
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractColumnInfo
```
public AbstractColumnInfo(String columnName,
                          String dataType,
                          int numberOfElements,
                          String keyType,
                          String columnDescription,
                          String valueDescriptionTable,
                          String thematicIndexFile,
                          String documentationFileName,
                          IlvVMAPTable associatedTable)
                   throws IlvVMAPFormatException
```
    Public constructor
    
    Parameters:
    
    columnName - Name of this column.
    
    dataType - Type of data held by this column.
    
    numberOfElements - Number of elements of dataType in this column.
    
    keyType - Key type for this column.
    
    columnDescription - Description of this column.
    
    valueDescriptionTable - Associated value description table file name (dash when not applicable).
    
    thematicIndexFile - Associated thematic index file name (dash when not applicable).
    
    documentationFileName - Associated documentation file name (dash when not applicable).
    
    associatedTable - The VMAP table to which this AbstractColumnInfo belongs.
    
    Throws:
    
    IlvVMAPFormatException
- Method Detail
  - getFieldType
```
public String getFieldType()
```
    Returns the type of the field described by this column.
    
    Returns:
    
    The type of the field described by this column. TEXT_TYPE, LEVEL_1_TEXT_TYPE, LEVEL_2_TEXT_TYPE, LEVEL_3_TEXT_TYPE, SHORT_FLOATING_POINT_TYPE, LONG_FLOATING_POINT_TYPE, SHORT_INTEGER_TYPE, LONG_INTEGER_TYPE, TWO_COORDINATE_SHORT_FLOATING_POINT_TYPE, TWO_COORDINATE_LONG_FLOATING_POINT_TYPE, THREE_COORDINATE_SHORT_FLOATING_POINT_TYPE, THREE_COORDINATE_LONG_FLOATING_POINT_TYPE, DATE_TIME_TYPE, NULL_FIELD_TYPE, or TRIPLET_ID_TYPE
  - getAssociatedTable
```
public IlvVMAPTable getAssociatedTable()
```
    Returns the VMAP table to which this AbstractColumnInfo belongs.
    
    Returns:
    
    The VMAP table to which this AbstractColumnInfo belongs.
  - getNumberOfElements
```
public int getNumberOfElements()
```
    Return the number of elements (of the specified type) in a field of this column (-1 if variable length field).
    
    Returns:
    
    The number of elements (-1 if variable length field).
  - getName
```
public String getName()
```
    Returns the name of this column.
    
    Returns:
    
    The name of this column.
  - getColumnDescription
```
public String getColumnDescription()
```
    Returns the description of this column.
    
    Returns:
    
    The description of this column.
  - getKeyType
```
public String getKeyType()
```
    Returns the type of key held by this column (primary, unique, non unique).
    
    Returns:
    
    The type of key.
  - getDocumentationFileName
```
public String getDocumentationFileName()
```
    Returns associated documentation file name.
    
    Returns:
    
    Associated documentation file name.
  - getThematicIndexFile
```
public String getThematicIndexFile()
```
    Returns associated thematic index file name.
    
    Returns:
    
    Associated thematic index file name.
  - getValueDescriptionTable
```
public String getValueDescriptionTable()
```
    Returns associated value table description file name.
    
    Returns:
    
    Associated value table description file name.
  - getFieldLength
```
public abstract int getFieldLength()
```
    Returns the length of the field associated with this class (-1 if variable length field).
    
    Returns:
    
    The length of the field associated with this class.
  - parseField
```
public abstract Object parseField(IlvVMAPDataInput VMAPDataInput)
                           throws IOException
```
    Parse appropriate data on the specified stream for this column type (implemented by concrete subclasses).
    
    Parameters:
    
    VMAPDataInput - The VMAP data stream to read on.
    
    Returns:
    
    Object A field value parsed on the stream (the actual class of the field depends on the subclass that implements this method).
    
    Throws:
    
    IOException
  - getFieldClass
```
public abstract Class<?> getFieldClass()
```
    Return the actual Class of the field associated with this column.
    
    Returns:
    
    The actual Class of the field.

Class AbstractColumnInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TEXT_TYPE

LEVEL_1_TEXT_TYPE

LEVEL_2_TEXT_TYPE

LEVEL_3_TEXT_TYPE

SHORT_FLOATING_POINT_TYPE

LONG_FLOATING_POINT_TYPE

SHORT_INTEGER_TYPE

LONG_INTEGER_TYPE

TWO_COORDINATE_SHORT_FLOATING_POINT_TYPE

TWO_COORDINATE_LONG_FLOATING_POINT_TYPE

THREE_COORDINATE_SHORT_FLOATING_POINT_TYPE

THREE_COORDINATE_LONG_FLOATING_POINT_TYPE

DATE_TIME_TYPE

NULL_FIELD_TYPE

TRIPLET_ID_TYPE

Constructor Detail

AbstractColumnInfo

Method Detail

getFieldType

getAssociatedTable

getNumberOfElements

getName

getColumnDescription

getKeyType

getDocumentationFileName

getThematicIndexFile

getValueDescriptionTable

getFieldLength

parseField

getFieldClass