org.formulacompiler.spreadsheet
Interface SpreadsheetByNameBinder


public interface SpreadsheetByNameBinder

Utility interface that supports simple cell binding using the cell names in the spreadsheet and reflection on the input and output types.

This interface is an API only. Do not implement it yourself.

Author:
peo
See Also:
EngineBuilder.getByNameBinder(), SpreadsheetCompiler.newSpreadsheetByNameBinder(SpreadsheetBinder)

Nested Class Summary
static interface SpreadsheetByNameBinder.CellBinder
          Interface to a cell binder for either input or output cells.
static class SpreadsheetByNameBinder.Config
          Configuration data for new instances of SpreadsheetByNameBinder.
static interface SpreadsheetByNameBinder.Factory
          Factory interface for ImplementationLocator.getInstance(Class).
 
Method Summary
 java.util.Map<java.lang.String,Spreadsheet.Range> cellNamesLeftUnbound()
          Returns the cell name definition this by-name binder has not bound to an input or output method.
 void failIfCellNamesAreStillUnbound()
          Raises an exception if there are named cells that were not bound.
 SpreadsheetByNameBinder.CellBinder inputs()
          Cell binder for input cells.
 SpreadsheetByNameBinder.CellBinder outputs()
          Cell binder for output cells.
 

Method Detail

inputs

SpreadsheetByNameBinder.CellBinder inputs()
Cell binder for input cells.

See Also:
outputs()

outputs

SpreadsheetByNameBinder.CellBinder outputs()
Cell binder for output cells.

See Also:
inputs()

cellNamesLeftUnbound

java.util.Map<java.lang.String,Spreadsheet.Range> cellNamesLeftUnbound()
Returns the cell name definition this by-name binder has not bound to an input or output method. Used to warn users about unbound cells.

See Also:
failIfCellNamesAreStillUnbound()

failIfCellNamesAreStillUnbound

void failIfCellNamesAreStillUnbound()
                                    throws SpreadsheetException
Raises an exception if there are named cells that were not bound.

Throws:
SpreadsheetException.NameNotFound - if there is an unbound name.
SpreadsheetException
See Also:
cellNamesLeftUnbound(), EngineBuilder.failIfByNameBindingLeftNamedCellsUnbound()