CSVWorkbook (IDARE [idare] 1.0 API)

java.lang.Object
- idare.imagenode.internal.DataSetReaders.CSVReader.CSVWorkbook

All Implemented Interfaces:

org.apache.poi.ss.usermodel.Workbook
```
public class CSVWorkbook
extends Object
implements org.apache.poi.ss.usermodel.Workbook
```
This class provides functionality to read text delimited files. It assumes, that there is no "text" delimiter, and that the delimiting character is never used at any other position. There will only ever be one Sheet in this object, and any sheet manipulations will fail or return null.

Author:

Thomas Pfau

Field Summary
- Fields inherited from interface org.apache.poi.ss.usermodel.Workbook
  PICTURE_TYPE_DIB, PICTURE_TYPE_EMF, PICTURE_TYPE_JPEG, PICTURE_TYPE_PICT, PICTURE_TYPE_PNG, PICTURE_TYPE_WMF, SHEET_STATE_HIDDEN, SHEET_STATE_VERY_HIDDEN, SHEET_STATE_VISIBLE

Constructor Summary

Constructors
Constructor and Description

CSVWorkbook(File F, String separator, int idColumnCount)
Create a new Workbook using a specific file and a defined separator.

Constructors
Constructor and Description
`CSVWorkbook(File F, String separator, int idColumnCount)` Create a new Workbook using a specific file and a defined separator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addPicture(byte[] arg0, int arg1)`
`void`	`addToolPack(org.apache.poi.ss.formula.udf.UDFFinder arg0)`
`org.apache.poi.ss.usermodel.Sheet`	`cloneSheet(int arg0)`
`org.apache.poi.ss.usermodel.CellStyle`	`createCellStyle()`
`org.apache.poi.ss.usermodel.DataFormat`	`createDataFormat()`
`org.apache.poi.ss.usermodel.Font`	`createFont()`
`org.apache.poi.ss.usermodel.Name`	`createName()`
`org.apache.poi.ss.usermodel.Sheet`	`createSheet()`
`org.apache.poi.ss.usermodel.Sheet`	`createSheet(String arg0)`
`org.apache.poi.ss.usermodel.Font`	`findFont(short arg0, short arg1, short arg2, String arg3, boolean arg4, boolean arg5, short arg6, byte arg7)`
`int`	`getActiveSheetIndex()`
`List<? extends org.apache.poi.ss.usermodel.PictureData>`	`getAllPictures()`
`org.apache.poi.ss.usermodel.CellStyle`	`getCellStyleAt(short arg0)`
`org.apache.poi.ss.usermodel.CreationHelper`	`getCreationHelper()`
`int`	`getFirstVisibleTab()`
`org.apache.poi.ss.usermodel.Font`	`getFontAt(short arg0)`
`boolean`	`getForceFormulaRecalculation()`
`org.apache.poi.ss.usermodel.Row.MissingCellPolicy`	`getMissingCellPolicy()`
`org.apache.poi.ss.usermodel.Name`	`getName(String arg0)`
`org.apache.poi.ss.usermodel.Name`	`getNameAt(int arg0)`
`int`	`getNameIndex(String arg0)`
`short`	`getNumberOfFonts()`
`int`	`getNumberOfNames()`
`int`	`getNumberOfSheets()`
`short`	`getNumCellStyles()`
`String`	`getPrintArea(int arg0)`
`org.apache.poi.ss.usermodel.Sheet`	`getSheet(String arg0)`
`org.apache.poi.ss.usermodel.Sheet`	`getSheetAt(int arg0)`
`int`	`getSheetIndex(org.apache.poi.ss.usermodel.Sheet arg0)`
`int`	`getSheetIndex(String arg0)`
`String`	`getSheetName(int arg0)`
`boolean`	`isHidden()`
`boolean`	`isSheetHidden(int arg0)`
`boolean`	`isSheetVeryHidden(int arg0)`
`void`	`removeName(int arg0)`
`void`	`removeName(String arg0)`
`void`	`removePrintArea(int arg0)`
`void`	`removeSheetAt(int arg0)`
`void`	`setActiveSheet(int arg0)`
`void`	`setFirstVisibleTab(int arg0)`
`void`	`setForceFormulaRecalculation(boolean arg0)`
`void`	`setHidden(boolean arg0)`
`void`	`setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy arg0)`
`void`	`setPrintArea(int arg0, int arg1, int arg2, int arg3, int arg4)`
`void`	`setPrintArea(int arg0, String arg1)`
`void`	`setRepeatingRowsAndColumns(int arg0, int arg1, int arg2, int arg3, int arg4)`
`void`	`setSelectedTab(int arg0)`
`void`	`setSheetHidden(int arg0, boolean arg1)`
`void`	`setSheetHidden(int arg0, int arg1)`
`void`	`setSheetName(int arg0, String arg1)`
`void`	`setSheetOrder(String arg0, int arg1)`
`String`	`toString()`
`void`	`write(OutputStream arg0)`

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

- Constructor Detail
  - CSVWorkbook
```
public CSVWorkbook(File F,
                   String separator,
                   int idColumnCount)
            throws IOException,
                   WrongFormat
```
    Create a new Workbook using a specific file and a defined separator.
    
    Parameters:
    
    F - - The file to read from.
    
    separator - the separator used in the Workbook
    
    idColumnCount - how many ID columns there are
    
    Throws:
    
    IOException - if something goes wrong during IO
    
    WrongFormat - if the format of the workbook is not proper CSV
- Method Detail
  - addPicture
```
public int addPicture(byte[] arg0,
                      int arg1)
```
    Specified by:
    
    addPicture in interface org.apache.poi.ss.usermodel.Workbook
  - addToolPack
```
public void addToolPack(org.apache.poi.ss.formula.udf.UDFFinder arg0)
```
    Specified by:
    
    addToolPack in interface org.apache.poi.ss.usermodel.Workbook
  - cloneSheet
```
public org.apache.poi.ss.usermodel.Sheet cloneSheet(int arg0)
```
    Specified by:
    
    cloneSheet in interface org.apache.poi.ss.usermodel.Workbook
  - createCellStyle
```
public org.apache.poi.ss.usermodel.CellStyle createCellStyle()
```
    Specified by:
    
    createCellStyle in interface org.apache.poi.ss.usermodel.Workbook
  - createDataFormat
```
public org.apache.poi.ss.usermodel.DataFormat createDataFormat()
```
    Specified by:
    
    createDataFormat in interface org.apache.poi.ss.usermodel.Workbook
  - createFont
```
public org.apache.poi.ss.usermodel.Font createFont()
```
    Specified by:
    
    createFont in interface org.apache.poi.ss.usermodel.Workbook
  - createName
```
public org.apache.poi.ss.usermodel.Name createName()
```
    Specified by:
    
    createName in interface org.apache.poi.ss.usermodel.Workbook
  - createSheet
```
public org.apache.poi.ss.usermodel.Sheet createSheet()
```
    Specified by:
    
    createSheet in interface org.apache.poi.ss.usermodel.Workbook
  - createSheet
```
public org.apache.poi.ss.usermodel.Sheet createSheet(String arg0)
```
    Specified by:
    
    createSheet in interface org.apache.poi.ss.usermodel.Workbook
  - findFont
```
public org.apache.poi.ss.usermodel.Font findFont(short arg0,
                                                 short arg1,
                                                 short arg2,
                                                 String arg3,
                                                 boolean arg4,
                                                 boolean arg5,
                                                 short arg6,
                                                 byte arg7)
```
    Specified by:
    
    findFont in interface org.apache.poi.ss.usermodel.Workbook
  - getActiveSheetIndex
```
public int getActiveSheetIndex()
```
    Specified by:
    
    getActiveSheetIndex in interface org.apache.poi.ss.usermodel.Workbook
  - getAllPictures
```
public List<? extends org.apache.poi.ss.usermodel.PictureData> getAllPictures()
```
    Specified by:
    
    getAllPictures in interface org.apache.poi.ss.usermodel.Workbook
  - getCreationHelper
```
public org.apache.poi.ss.usermodel.CreationHelper getCreationHelper()
```
    Specified by:
    
    getCreationHelper in interface org.apache.poi.ss.usermodel.Workbook
  - getFirstVisibleTab
```
public int getFirstVisibleTab()
```
    Specified by:
    
    getFirstVisibleTab in interface org.apache.poi.ss.usermodel.Workbook
  - getFontAt
```
public org.apache.poi.ss.usermodel.Font getFontAt(short arg0)
```
    Specified by:
    
    getFontAt in interface org.apache.poi.ss.usermodel.Workbook
  - getForceFormulaRecalculation
```
public boolean getForceFormulaRecalculation()
```
    Specified by:
    
    getForceFormulaRecalculation in interface org.apache.poi.ss.usermodel.Workbook
  - getMissingCellPolicy
```
public org.apache.poi.ss.usermodel.Row.MissingCellPolicy getMissingCellPolicy()
```
    Specified by:
    
    getMissingCellPolicy in interface org.apache.poi.ss.usermodel.Workbook
  - getName
```
public org.apache.poi.ss.usermodel.Name getName(String arg0)
```
    Specified by:
    
    getName in interface org.apache.poi.ss.usermodel.Workbook
  - getNameAt
```
public org.apache.poi.ss.usermodel.Name getNameAt(int arg0)
```
    Specified by:
    
    getNameAt in interface org.apache.poi.ss.usermodel.Workbook
  - getNameIndex
```
public int getNameIndex(String arg0)
```
    Specified by:
    
    getNameIndex in interface org.apache.poi.ss.usermodel.Workbook
  - getNumberOfFonts
```
public short getNumberOfFonts()
```
    Specified by:
    
    getNumberOfFonts in interface org.apache.poi.ss.usermodel.Workbook
  - getNumberOfNames
```
public int getNumberOfNames()
```
    Specified by:
    
    getNumberOfNames in interface org.apache.poi.ss.usermodel.Workbook
  - getNumberOfSheets
```
public int getNumberOfSheets()
```
    Specified by:
    
    getNumberOfSheets in interface org.apache.poi.ss.usermodel.Workbook
  - getPrintArea
```
public String getPrintArea(int arg0)
```
    Specified by:
    
    getPrintArea in interface org.apache.poi.ss.usermodel.Workbook
  - getSheet
```
public org.apache.poi.ss.usermodel.Sheet getSheet(String arg0)
```
    Specified by:
    
    getSheet in interface org.apache.poi.ss.usermodel.Workbook
  - getSheetAt
```
public org.apache.poi.ss.usermodel.Sheet getSheetAt(int arg0)
```
    Specified by:
    
    getSheetAt in interface org.apache.poi.ss.usermodel.Workbook
  - getSheetIndex
```
public int getSheetIndex(String arg0)
```
    Specified by:
    
    getSheetIndex in interface org.apache.poi.ss.usermodel.Workbook
  - getSheetIndex
```
public int getSheetIndex(org.apache.poi.ss.usermodel.Sheet arg0)
```
    Specified by:
    
    getSheetIndex in interface org.apache.poi.ss.usermodel.Workbook
  - getSheetName
```
public String getSheetName(int arg0)
```
    Specified by:
    
    getSheetName in interface org.apache.poi.ss.usermodel.Workbook
  - isHidden
```
public boolean isHidden()
```
    Specified by:
    
    isHidden in interface org.apache.poi.ss.usermodel.Workbook
  - isSheetHidden
```
public boolean isSheetHidden(int arg0)
```
    Specified by:
    
    isSheetHidden in interface org.apache.poi.ss.usermodel.Workbook
  - isSheetVeryHidden
```
public boolean isSheetVeryHidden(int arg0)
```
    Specified by:
    
    isSheetVeryHidden in interface org.apache.poi.ss.usermodel.Workbook
  - removeName
```
public void removeName(int arg0)
```
    Specified by:
    
    removeName in interface org.apache.poi.ss.usermodel.Workbook
  - removeName
```
public void removeName(String arg0)
```
    Specified by:
    
    removeName in interface org.apache.poi.ss.usermodel.Workbook
  - removePrintArea
```
public void removePrintArea(int arg0)
```
    Specified by:
    
    removePrintArea in interface org.apache.poi.ss.usermodel.Workbook
  - removeSheetAt
```
public void removeSheetAt(int arg0)
```
    Specified by:
    
    removeSheetAt in interface org.apache.poi.ss.usermodel.Workbook
  - setActiveSheet
```
public void setActiveSheet(int arg0)
```
    Specified by:
    
    setActiveSheet in interface org.apache.poi.ss.usermodel.Workbook
  - setFirstVisibleTab
```
public void setFirstVisibleTab(int arg0)
```
    Specified by:
    
    setFirstVisibleTab in interface org.apache.poi.ss.usermodel.Workbook
  - setForceFormulaRecalculation
```
public void setForceFormulaRecalculation(boolean arg0)
```
    Specified by:
    
    setForceFormulaRecalculation in interface org.apache.poi.ss.usermodel.Workbook
  - setHidden
```
public void setHidden(boolean arg0)
```
    Specified by:
    
    setHidden in interface org.apache.poi.ss.usermodel.Workbook
  - setMissingCellPolicy
```
public void setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy arg0)
```
    Specified by:
    
    setMissingCellPolicy in interface org.apache.poi.ss.usermodel.Workbook
  - setPrintArea
```
public void setPrintArea(int arg0,
                         String arg1)
```
    Specified by:
    
    setPrintArea in interface org.apache.poi.ss.usermodel.Workbook
  - setPrintArea
```
public void setPrintArea(int arg0,
                         int arg1,
                         int arg2,
                         int arg3,
                         int arg4)
```
    Specified by:
    
    setPrintArea in interface org.apache.poi.ss.usermodel.Workbook
  - setRepeatingRowsAndColumns
```
public void setRepeatingRowsAndColumns(int arg0,
                                       int arg1,
                                       int arg2,
                                       int arg3,
                                       int arg4)
```
    Specified by:
    
    setRepeatingRowsAndColumns in interface org.apache.poi.ss.usermodel.Workbook
  - setSelectedTab
```
public void setSelectedTab(int arg0)
```
    Specified by:
    
    setSelectedTab in interface org.apache.poi.ss.usermodel.Workbook
  - setSheetHidden
```
public void setSheetHidden(int arg0,
                           boolean arg1)
```
    Specified by:
    
    setSheetHidden in interface org.apache.poi.ss.usermodel.Workbook
  - setSheetHidden
```
public void setSheetHidden(int arg0,
                           int arg1)
```
    Specified by:
    
    setSheetHidden in interface org.apache.poi.ss.usermodel.Workbook
  - setSheetName
```
public void setSheetName(int arg0,
                         String arg1)
```
    Specified by:
    
    setSheetName in interface org.apache.poi.ss.usermodel.Workbook
  - setSheetOrder
```
public void setSheetOrder(String arg0,
                          int arg1)
```
    Specified by:
    
    setSheetOrder in interface org.apache.poi.ss.usermodel.Workbook
  - write
```
public void write(OutputStream arg0)
           throws IOException
```
    Specified by:
    
    write in interface org.apache.poi.ss.usermodel.Workbook
    
    Throws:
    
    IOException
  - getCellStyleAt
```
public org.apache.poi.ss.usermodel.CellStyle getCellStyleAt(short arg0)
```
    Specified by:
    
    getCellStyleAt in interface org.apache.poi.ss.usermodel.Workbook
  - getNumCellStyles
```
public short getNumCellStyles()
```
    Specified by:
    
    getNumCellStyles in interface org.apache.poi.ss.usermodel.Workbook
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CSVWorkbook

Field Summary

Fields inherited from interface org.apache.poi.ss.usermodel.Workbook

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CSVWorkbook

Method Detail

addPicture

addToolPack

cloneSheet

createCellStyle

createDataFormat

createFont

createName

createSheet

createSheet

findFont

getActiveSheetIndex

getAllPictures

getCreationHelper

getFirstVisibleTab

getFontAt

getForceFormulaRecalculation

getMissingCellPolicy

getName

getNameAt

getNameIndex

getNumberOfFonts

getNumberOfNames

getNumberOfSheets

getPrintArea

getSheet

getSheetAt

getSheetIndex

getSheetIndex

getSheetName

isHidden

isSheetHidden

isSheetVeryHidden

removeName

removeName

removePrintArea

removeSheetAt

setActiveSheet

setFirstVisibleTab

setForceFormulaRecalculation

setHidden

setMissingCellPolicy

setPrintArea

setPrintArea

setRepeatingRowsAndColumns

setSelectedTab

setSheetHidden

setSheetHidden

setSheetName

setSheetOrder

write

getCellStyleAt

getNumCellStyles

toString