ImportBinary

java.lang.Object
- signalproc.input.ImportBinary

```
public class ImportBinary
extends java.lang.Object
```
An utility class for importing binary data input streams

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYTE`
`static int`	`DOUBLE`
`static int`	`FLOAT`
`protected java.io.InputStream`	`instream` the stream data is being input from
`static int`	`INT`
`static int`	`LONG`
`static int`	`SHORT`

Constructor Summary

Constructors
Constructor and Description

ImportBinary(java.io.InputStream instream)

Constructors
Constructor and Description
`ImportBinary(java.io.InputStream instream)`

Method Summary

Methods
Modifier and Type	Method and Description
`static double`	`byteToDouble(byte[] bytes, int offset)` Converts the short bytes at the given offset into a double by packing the bytes in the correct order.
`void`	`close()` Closes the import binary and the underlying data stream
`static double`	`doubleBytesToDouble(byte[] bytes, int offset)` Converts the double bytes at the given offset into a double by packing the bytes in the correct order.
`static double`	`floatBytesToDouble(byte[] bytes, int offset)` Converts the float bytes at the given offset into a double by packing the bytes in the correct order.
`int`	`getActualRows()`
`int`	`getColumns()`
`int`	`getDataType()`
`int`	`getRows()`
`static double`	`intBytesToDouble(byte[] bytes, int offset)` Converts the int bytes at the given offset into a double by packing the bytes in the correct order.
`boolean`	`isOneBytePerColumn()`
`boolean`	`isReverseByteOrder()`
`static double`	`longBytesToDouble(byte[] bytes, int offset)` Converts the long bytes at the given offset into a double by packing the bytes in the correct order.
`void`	`nextDataSet()` Moves to the next data set in the input stream
`boolean`	`offset(int amount)` Offsets the data by the specified number of bytes/characters (returns fales if the end of input stream is reached)
`protected boolean`	`readAdditionalRow()` Reads in an additional row when the number of rows is unspecified
`protected boolean`	`readColumnData(DataSchema rowschema)` Reads in a data set when importing columns.
`VectorType[]`	`readColumns(DataSchema colschema, DataSchema rowschema)`
`VectorType`	`readRow(DataSchema colschema, DataSchema rowschema)`
`protected boolean`	`readRowData(DataSchema rowschema)` Reads in a data set when importing rows (only if at the start of the set)
`static double`	`reverseDoubleBytesToDouble(byte[] bytes, int offset)` Converts the double bytes at the given offset into a double by packing the bytes in reverse order
`static double`	`reverseFloatBytesToDouble(byte[] bytes, int offset)` Converts the float bytes at the given offset into a double by packing the bytes in reverse order
`static double`	`reverseIntBytesToDouble(byte[] bytes, int offset)` Converts the int bytes at the given offset into a double by packing the bytes in reverse order
`static double`	`reverseLongBytesToDouble(byte[] bytes, int offset)` Converts the long bytes at the given offset into a double by packing the bytes in reverse order
`static double`	`reverseShortBytesToDouble(byte[] bytes, int offset)` Converts the short bytes at the given offset into a double by packing the bytes in reverse order
`protected void`	`setActualRows(int actualrows)` Sets the actual number of rows read in for the last data set
`void`	`setColumns(int columns)` Sets the number of columns in each data set
`void`	`setDataType(int datatype)` Sets the type of data being read in
`void`	`setOneBytePerColumn(boolean state)` Sets whether each column is one byte (or alternatively whether the number of bytes in a field is the same as the data type
`void`	`setReverseByteOrder(boolean reverse)` Sets whether the data is in reverse byte order
`void`	`setRows(int rows)` Sets the number of rows in each data set, or -1 if unknown
`static double`	`shortBytesToDouble(byte[] bytes, int offset)` Converts the short bytes at the given offset into a double by packing the bytes in the correct order.

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

- Field Detail
  - BYTE
```
public static final int BYTE
```
    See Also:
    Constant Field Values
  - SHORT
```
public static final int SHORT
```
    See Also:
    Constant Field Values
  - INT
```
public static final int INT
```
    See Also:
    Constant Field Values
  - LONG
```
public static final int LONG
```
    See Also:
    Constant Field Values
  - FLOAT
```
public static final int FLOAT
```
    See Also:
    Constant Field Values
  - DOUBLE
```
public static final int DOUBLE
```
    See Also:
    Constant Field Values
  - instream
```
protected java.io.InputStream instream
```
    the stream data is being input from
- Constructor Detail
  - ImportBinary
```
public ImportBinary(java.io.InputStream instream)
```
- Method Detail
  - getDataType
```
public int getDataType()
```
    Returns:
    the type of data being read in
  - setDataType
```
public void setDataType(int datatype)
```
    Sets the type of data being read in
  - isOneBytePerColumn
```
public boolean isOneBytePerColumn()
```
    Returns:
    true is the number of bytes for each column field is the same as the number for the data type (false if it is one byte per column)
  - setOneBytePerColumn
```
public void setOneBytePerColumn(boolean state)
```
    Sets whether each column is one byte (or alternatively whether the number of bytes in a field is the same as the data type
  - isReverseByteOrder
```
public boolean isReverseByteOrder()
```
    Returns:
    true if the data is in reverse byte order
  - setReverseByteOrder
```
public void setReverseByteOrder(boolean reverse)
```
    Sets whether the data is in reverse byte order
  - getRows
```
public int getRows()
```
    Returns:
    the number of rows in each data set, or -1 if unknown
  - getActualRows
```
public int getActualRows()
```
    Returns:
    the actual number of rows read in for the last data set
  - setRows
```
public void setRows(int rows)
```
    Sets the number of rows in each data set, or -1 if unknown
  - setActualRows
```
protected void setActualRows(int actualrows)
```
    Sets the actual number of rows read in for the last data set
  - getColumns
```
public int getColumns()
```
    Returns:
    the number of columns in each data set
  - setColumns
```
public void setColumns(int columns)
```
    Sets the number of columns in each data set
  - nextDataSet
```
public void nextDataSet()
                 throws java.io.IOException
```
    Moves to the next data set in the input stream
    
    Throws:
    
    java.io.IOException
  - offset
```
public boolean offset(int amount)
               throws java.io.IOException
```
    Offsets the data by the specified number of bytes/characters (returns fales if the end of input stream is reached)
    
    Throws:
    
    java.io.IOException
  - close
```
public void close()
           throws java.io.IOException
```
    Closes the import binary and the underlying data stream
    
    Throws:
    
    java.io.IOException
  - readColumns
```
public VectorType[] readColumns(DataSchema colschema,
                       DataSchema rowschema)
                         throws java.io.IOException
```
    Parameters:
    colschema - the columns that are to be read in (e.g. 2,3,6-10)
    rowschema - the rows that are to be included in the column (e.g. 2,3,8-10,15+)
    
    Returns:
    an array of columns read from the input stream according to the given schema (returns null if the end of input stream is reached)
    
    Throws:
    
    java.io.IOException
  - readColumnData
```
protected boolean readColumnData(DataSchema rowschema)
                          throws java.io.IOException
```
    Reads in a data set when importing columns.
    
    Returns:
    true if the data set has been fully read
    
    Throws:
    
    java.io.IOException
  - readRow
```
public VectorType readRow(DataSchema colschema,
                 DataSchema rowschema)
                   throws java.io.IOException
```
    Parameters:
    colschema - the columns that are to be included in the row (e.g. 2,3,6-10,15+)
    rowschema - the rows that are to be read in (e.g. 2,3,8-10,15+)
    
    Returns:
    a single row read from the input stream according to the given schemas (returns null if the end of input stream/end of data set is reached)
    
    Throws:
    
    java.io.IOException
  - readRowData
```
protected boolean readRowData(DataSchema rowschema)
                       throws java.io.IOException
```
    Reads in a data set when importing rows (only if at the start of the set)
    
    Returns:
    true if the data set was fully read
    
    Throws:
    
    java.io.IOException
  - readAdditionalRow
```
protected boolean readAdditionalRow()
                             throws java.io.IOException
```
    Reads in an additional row when the number of rows is unspecified
    
    Returns:
    true if the additional row was fully read
    
    Throws:
    
    java.io.IOException
  - byteToDouble
```
public static final double byteToDouble(byte[] bytes,
                  int offset)
```
    Converts the short bytes at the given offset into a double by packing the bytes in the correct order.
  - shortBytesToDouble
```
public static final double shortBytesToDouble(byte[] bytes,
                        int offset)
```
    Converts the short bytes at the given offset into a double by packing the bytes in the correct order.
  - intBytesToDouble
```
public static final double intBytesToDouble(byte[] bytes,
                      int offset)
```
    Converts the int bytes at the given offset into a double by packing the bytes in the correct order.
  - floatBytesToDouble
```
public static final double floatBytesToDouble(byte[] bytes,
                        int offset)
```
    Converts the float bytes at the given offset into a double by packing the bytes in the correct order.
  - longBytesToDouble
```
public static final double longBytesToDouble(byte[] bytes,
                       int offset)
```
    Converts the long bytes at the given offset into a double by packing the bytes in the correct order.
  - doubleBytesToDouble
```
public static final double doubleBytesToDouble(byte[] bytes,
                         int offset)
```
    Converts the double bytes at the given offset into a double by packing the bytes in the correct order.
  - reverseShortBytesToDouble
```
public static final double reverseShortBytesToDouble(byte[] bytes,
                               int offset)
```
    Converts the short bytes at the given offset into a double by packing the bytes in reverse order
  - reverseIntBytesToDouble
```
public static final double reverseIntBytesToDouble(byte[] bytes,
                             int offset)
```
    Converts the int bytes at the given offset into a double by packing the bytes in reverse order
  - reverseFloatBytesToDouble
```
public static final double reverseFloatBytesToDouble(byte[] bytes,
                               int offset)
```
    Converts the float bytes at the given offset into a double by packing the bytes in reverse order
  - reverseLongBytesToDouble
```
public static final double reverseLongBytesToDouble(byte[] bytes,
                              int offset)
```
    Converts the long bytes at the given offset into a double by packing the bytes in reverse order
  - reverseDoubleBytesToDouble
```
public static final double reverseDoubleBytesToDouble(byte[] bytes,
                                int offset)
```
    Converts the double bytes at the given offset into a double by packing the bytes in reverse order

Class ImportBinary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BYTE

SHORT

INT

LONG

FLOAT

DOUBLE

instream

Constructor Detail

ImportBinary

Method Detail

getDataType

setDataType

isOneBytePerColumn

setOneBytePerColumn

isReverseByteOrder

setReverseByteOrder

getRows

getActualRows

setRows

setActualRows

getColumns

setColumns

nextDataSet

offset

close

readColumns

readColumnData

readRow

readRowData

readAdditionalRow

byteToDouble

shortBytesToDouble

intBytesToDouble

floatBytesToDouble

longBytesToDouble

doubleBytesToDouble

reverseShortBytesToDouble

reverseIntBytesToDouble

reverseFloatBytesToDouble

reverseLongBytesToDouble

reverseDoubleBytesToDouble