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.joone.io
Class XLSInputSynapse

    java.lang.Object
      org.joone.engine.Synapse
          org.joone.io.StreamInputSynapse
              org.joone.io.XLSInputSynapse

All Implemented Interfaces:
  java.io.Serializable, InputPatternListener, Learnable, LearnableSynapse, NeuralElement, OutputPatternListener, Inspectable, InputSynapse, PlugInListener

    public class XLSInputSynapse

extends StreamInputSynapse

This class allows data to be presented to the network from an Excel XLS formatted file. The XLS file name must be specified and a worksheet name is optional.

See Also:
  Serialized Form

Field Summary

Fields inherited from class org.joone.io.StreamInputSynapse
`cols, currentRow, EOF, InputVector, plugInListeners, tokens`

Fields inherited from class org.joone.engine.Synapse
`array, b_pattern, bitems, bouts, count, enabled, fwdLock, inps, items, learnable, m_batch, m_pattern, myLearner, notFirstTime, notFirstTimeB, outs, revLock`

Constructor Summary
`XLSInputSynapse()` The default constructor for this XLSInputSynapse.

Method Summary
`java.util.TreeSet` | `check()` Returns a TreeSet of problems or errors with the setup of this XLSInputSynapse object.
`java.lang.String[]` | `getAvailableSheetList()` Gets a list of available sheets from the XLS file.
`java.lang.String` | `getFileName()` Deprecated. use getInputFile instead
`java.io.File` | `getInputFile()`
`protected HSSFSheet` | `getSheet(java.lang.String sheetName)` Gets the HSSF sheet from the XLS file using the specified sheet name.
`java.lang.String` | `getSheetName()` Gets the name of the sheet within the XLS file to extract data from for input to the network.
`protected void` | `initInputStream()` Reads data from the XLS file into this synapse.
`void` | `setFileName(java.lang.String newFileName)` Deprecated. use setInputFile instead
`void` | `setInputFile(java.io.File inputFile)`
`void` | `setSheetName(java.lang.String sheetName)` Sets the name of the sheet within the XLS file to extract input data from.

Methods inherited from class org.joone.io.StreamInputSynapse
`addPlugIn, addPlugInListener, backward, dataChanged, fireDataChanged, forward, fwdGet, fwdGet, getAdvancedColumnSelector, getAllPlugInListeners, getCurrentRow, getDecimalPoint, getFirstCol, getFirstRow, getInputPatterns, getInputVector, getLastCol, getLastRow, getMaxBufSize, getPlugIn, getStream, getTokens, gotoFirstLine, gotoLine, InspectableTitle, Inspections, isBuffered, isEOF, isStepCounter, numColumns, readAll, readObjectBase, removeAllPlugIns, removePlugInListener, reset, resetInput, revPut, setAdvancedColumnSelector, setArrays, setBuffered, setColList, setDecimalPoint, setDimensions, setEOF, setFirstCol, setFirstRow, setInputPatterns, setLastCol, setLastRow, setMaxBufSize, setPlugin, setPlugIn, setStepCounter, setTokens, writeObjectBase, zeroPattern`

Methods inherited from class org.joone.engine.Synapse
`addNoise, canCountSteps, fwdPut, getFwdLock, getIgnoreBefore, getInputDimension, getLearner, getLearningRate, getMomentum, getMonitor, getName, getOutputDimension, getRevLock, getWeights, init, initLearner, isEnabled, isInputFull, isLoopBack, isOutputFull, randomize, readResolve, revGet, setEnabled, setIgnoreBefore, setInputDimension, setInputFull, setLearningRate, setLoopBack, setMomentum, setMonitor, setName, setOutputDimension, setOutputFull, setWeights`

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

Constructor Detail

### XLSInputSynapse

    public XLSInputSynapse()

  The default constructor for this XLSInputSynapse.

Method Detail

### getFileName

    public java.lang.String getFileName()

  Deprecated. use getInputFile instead

  Gets the XLS file name used as input to the network.

  Returns:
    The XLS input file name.

### setFileName

    public void setFileName(java.lang.String newFileName)

  Deprecated. use setInputFile instead

  Sets the XLS file name that should be used to obtain input data from.

  Parameters:
    `newFileName` - The XLS file name that should be used to obtain input data from.

### initInputStream

    protected void initInputStream()
                            throws JooneRuntimeException

  Reads data from the XLS file into this synapse.

  Specified by:
    `initInputStream` in class `StreamInputSynapse`
  Throws:
    `JooneRuntimeException`

### getSheet

    protected HSSFSheet getSheet(java.lang.String sheetName)

  Gets the HSSF sheet from the XLS file using the specified sheet name.

  Returns:
    The HSSFSheet

### setSheetName

    public void setSheetName(java.lang.String sheetName)

  Sets the name of the sheet within the XLS file to extract input data from.

  Parameters:
    `sheetName` - The name of the sheet within the XLS file to extract input data from.

### getAvailableSheetList

    public java.lang.String[] getAvailableSheetList()

  Gets a list of available sheets from the XLS file.

  Returns:
    The list of available sheets from the XLS file or null if the file name has not been set.

### getSheetName

    public java.lang.String getSheetName()

  Gets the name of the sheet within the XLS file to extract data from for input to the network.

  Returns:
    The name of the sheet within the XLS file to extract data from for input to the network.

### check

    public java.util.TreeSet check()

  Returns a TreeSet of problems or errors with the setup of this XLSInputSynapse object.

  Specified by:
    `check` in interface `NeuralElement`
  Overrides:
    `check` in class `StreamInputSynapse`
  Returns:
    A TreeSet of problems or errors with the setup of this XLSInputSynapse object.
  See Also:
    `Synapse`

### getInputFile

    public java.io.File getInputFile()

### setInputFile

    public void setInputFile(java.io.File inputFile)

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

Submit Feedback to pmarrone@users.sourceforge.net