Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.encog.ml.data.buffer.codec
Class ExcelCODEC

    java.lang.Object
      org.encog.ml.data.buffer.codec.ExcelCODEC

All Implemented Interfaces:
  DataSetCODEC

    public class ExcelCODEC

extends Object
implements DataSetCODEC

A CODEC that can read/write Microsoft Excel (*.XLSX) files.

Constructor Summary
`ExcelCODEC(File theFile)` Constructor to create Excel from binary.
`ExcelCODEC(File theFile, int theInputCount, int theIdealCount)` Create a CODEC to load data from Excel to binary.

Method Summary
`void` | `close()` Close any open files.
`int` | `getIdealSize()`
`int` | `getInputSize()`
`void` | `prepareRead()` Prepare to read from an external data source.
`void` | `prepareWrite(int recordCount, int inputSize, int idealSize)` Prepare to write to an external data destination.
`boolean` | `read(double[] input, double[] ideal, double[] significance)` Read one record of data from an external source.
`void` | `write(double[] input, double[] ideal, double significance)` Write one record of data to an external destination.

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

Constructor Detail

### ExcelCODEC

    public ExcelCODEC(File theFile)

  Constructor to create Excel from binary.

  Parameters:
    `theFile` - The CSV file to create.

### ExcelCODEC

    public ExcelCODEC(File theFile,
                      int theInputCount,
                      int theIdealCount)

  Create a CODEC to load data from Excel to binary.

  Parameters:
    `theFile` - The Excel file to load.
    `theInputCount` - The number of input columns.
    `theIdealCount` - The number of ideal columns.

Method Detail

### close

    public final void close()

  Close any open files.

  Specified by:
    `close` in interface `DataSetCODEC`

### getIdealSize

    public final int getIdealSize()

  Specified by:
    `getIdealSize` in interface `DataSetCODEC`
  Returns:
    The size of the ideal data.

### getInputSize

    public final int getInputSize()

  Specified by:
    `getInputSize` in interface `DataSetCODEC`
  Returns:
    The size of the input data.

### prepareRead

    public final void prepareRead()

  Prepare to read from an external data source.

  Specified by:
    `prepareRead` in interface `DataSetCODEC`

### prepareWrite

    public final void prepareWrite(int recordCount,
                                   int inputSize,
                                   int idealSize)

  Prepare to write to an external data destination.

  Specified by:
    `prepareWrite` in interface `DataSetCODEC`
  Parameters:
    `recordCount` - The total record count, that will be written.
    `inputSize` - The input size.
    `idealSize` - The ideal size.

### read

    public final boolean read(double[] input,
                              double[] ideal,
                              double[] significance)

  Read one record of data from an external source.

  Specified by:
    `read` in interface `DataSetCODEC`
  Parameters:
    `input` - The input data array.
    `ideal` - The ideal data array.
  Returns:
    True, if there is more data to be read.

### write

    public final void write(double[] input,
                            double[] ideal,
                            double significance)

  Write one record of data to an external destination.

  Specified by:
    `write` in interface `DataSetCODEC`
  Parameters:
    `input` - The input data array.
    `ideal` - The ideal data array.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2011. All Rights Reserved.