ilog.views.maps.defense.format.vmap

Class IlvVMAPTable

java.lang.Object

ilog.views.maps.defense.format.vmap.IlvVMAPTable

public class IlvVMAPTable
extends Object

IlvVMAPTable encapsulates a VMAP table and reads records from it.

Since:

JViews 7.0

Constructor Summary

Constructors

Constructor and Description
IlvVMAPTable(String fileName) Constructs an IlvVMAPTable object from the specified filename.

Method Summary

Modifier and Type	Method and Description
void	closeVMAPDataInput() Closes the underlying data connection.
int	getColumnCount() Returns the number of columns in this table.
int	getColumnIndex(String columnName) Returns the index of the column with the name specified.
AbstractColumnInfo	getColumnInfo(int columnIndex) Returns the AbstractColumnInfo object for a specified column index.
String	getColumnName(int columnIndex) Returns the name of a specified column.
String	getFileName() Returns the filename for this table.
Object[]	getRecord(int recordIndex) Returns the record for the index specified.
int	getRecordCount() Returns the number of records in this table.
Object	getRecordFieldByIndex(int recordIndex, int fieldIndex) Returns the value of a particular column, specified by its index for a specific record.
Object	getRecordFieldByName(int recordIndex, String fieldName) Returns the value of a particular column, specified by name for a specific record.
boolean	isLSBFirst() Returns true if this table has least significant byte first encoding.
double	readDouble(IlvVMAPDataInput VMAPDataInput) Reads a double instance (8 bytes) from the specified stream, according to the byte order of this table.
float	readFloat(IlvVMAPDataInput VMAPDataInput) Read a float instance (4 bytes) from the specified stream, according to the byte order of this table.
int	readInt(byte[] byteArray) Reads an integer from a byte array (length must be >= 4), according to the byte order specified in this table.
int	readInt(IlvVMAPDataInput VMAPDataInput) Reads an int object (4 bytes) from the specified stream, according to the byte order of this table.
long	readLong(IlvVMAPDataInput VMAPDataInput) Reads a long instance (8 bytes) from the specified stream, according to the byte order of this table.
short	readShort(IlvVMAPDataInput VMAPDataInput) Reads a short object (2 bytes) from the specified stream, according to the byte order of this table.
void	readTable(boolean fullyRead) Constructs this IlvVMAPTable object by reading attributes from the associated file.
int	searchRecordByColumnValue(int columnIndex, Object value) Search for the first record encountered that contains a specified value for a specific column.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvVMAPTable

public IlvVMAPTable(String fileName)

Constructs an IlvVMAPTable object from the specified filename.

Parameters:

fileName - The filename to read the table from.

Method Detail

getFileName

public String getFileName()

Returns the filename for this table.

Returns:

The filename for this table.

isLSBFirst

public boolean isLSBFirst()

Returns true if this table has least significant byte first encoding.

Returns:

If this table has least significant byte first encoding, true is returned.

readTable

public void readTable(boolean fullyRead)
               throws IOException,
                      IlvVMAPFormatException

Constructs this IlvVMAPTable object by reading attributes from the associated file.

Parameters:

fullyRead - If true, the whole table is loaded into memory, otherwise records are read on demand.

Throws:

IOException

IlvVMAPFormatException

closeVMAPDataInput

public void closeVMAPDataInput()
                        throws IOException

Closes the underlying data connection.

Throws:

IOException

readInt

public int readInt(byte[] byteArray)

Reads an integer from a byte array (length must be >= 4), according to the byte order specified in this table.

Parameters:

byteArray - The byte array (4 bytes) from which to read an integer.

Returns:

The int value of this array.

readInt

public int readInt(IlvVMAPDataInput VMAPDataInput)
            throws IOException

Reads an int object (4 bytes) from the specified stream, according to the byte order of this table.

Parameters:

VMAPDataInput - The VMAP data input to read from.

Returns:

The integer read.

Throws:

IOException

Since:

JViews 8.1

readShort

public short readShort(IlvVMAPDataInput VMAPDataInput)
                throws IOException

Reads a short object (2 bytes) from the specified stream, according to the byte order of this table.

Parameters:

VMAPDataInput - The VMAP data input to read from.

Returns:

The short integer read.

Throws:

IOException

Since:

JViews 8.1

readLong

public long readLong(IlvVMAPDataInput VMAPDataInput)
              throws IOException

Reads a long instance (8 bytes) from the specified stream, according to the byte order of this table.

Parameters:

VMAPDataInput - The VMAP data input to read from.

Returns:

The long integer read.

Throws:

IOException

Since:

JViews 8.1

readFloat

public float readFloat(IlvVMAPDataInput VMAPDataInput)
                throws IOException

Read a float instance (4 bytes) from the specified stream, according to the byte order of this table.

Parameters:

VMAPDataInput - The VMAP data input to read from.

Returns:

The float read.

Throws:

IOException

Since:

JViews 8.1

readDouble

public double readDouble(IlvVMAPDataInput VMAPDataInput)
                  throws IOException

Reads a double instance (8 bytes) from the specified stream, according to the byte order of this table.

Parameters:

VMAPDataInput - The VMAP data input to read from.

Returns:

The double read.

Throws:

IOException

Since:

JViews 8.1

getRecord

public Object[] getRecord(int recordIndex)
                   throws IOException,
                          IlvVMAPFormatException

Returns the record for the index specified.

Parameters:

recordIndex - The index of the record.

Returns:

The record at the index specified. If recordIndex is out of bounds, null is returned.

Throws:

IOException

IlvVMAPFormatException

getRecordFieldByName

public Object getRecordFieldByName(int recordIndex,
                                   String fieldName)
                            throws IOException,
                                   IlvVMAPFormatException

Returns the value of a particular column, specified by name for a specific record.

Parameters:

recordIndex - The index of the record.

fieldName - The field name.

Returns:

The field value.

Throws:

IOException

IlvVMAPFormatException

getRecordFieldByIndex

public Object getRecordFieldByIndex(int recordIndex,
                                    int fieldIndex)
                             throws IOException,
                                    IlvVMAPFormatException

Returns the value of a particular column, specified by its index for a specific record.

Parameters:

recordIndex - The record index.

fieldIndex - The field index.

Returns:

The field value.

Throws:

IOException

IlvVMAPFormatException

searchRecordByColumnValue

public int searchRecordByColumnValue(int columnIndex,
                                     Object value)
                              throws IOException,
                                     IlvVMAPFormatException

Search for the first record encountered that contains a specified value for a specific column.

Note: this implementation is slow.

Parameters:

columnIndex - The column index.

value - The value to search for.

Returns:

The index of found record.

Throws:

IOException

IlvVMAPFormatException

getColumnCount

public int getColumnCount()

Returns the number of columns in this table.

Returns:

The number of columns in this table.

getColumnName

public String getColumnName(int columnIndex)

Returns the name of a specified column.

Parameters:

columnIndex - The column index.

Returns:

The name of the column.

getColumnInfo

public AbstractColumnInfo getColumnInfo(int columnIndex)

Returns the AbstractColumnInfo object for a specified column index.

Parameters:

columnIndex - The column index.

Returns:

The column information.

getColumnIndex

public int getColumnIndex(String columnName)

Returns the index of the column with the name specified.

Parameters:

columnName - The column name.

Returns:

The index of the column with name specified. If the column is not found -1 is returned.s

getRecordCount

public int getRecordCount()

Returns the number of records in this table.

Returns:

The number of records in this table.