Home » JCraft » jxl.read » biff » [javadoc | source]
jxl.read.biff
public class: WorkbookParser [javadoc | source]
java.lang.Object
   jxl.Workbook
      jxl.read.biff.WorkbookParser

All Implemented Interfaces:
    WorkbookMethods, ExternalSheet

Parses the biff file passed in, and builds up an internal representation of the spreadsheet
Constructor:
 public WorkbookParser(File f,
    WorkbookSettings s) 
    Constructs this object from the raw excel data
    Parameters:
    f - the excel 97 biff file
    s - the workbook settings
Method from jxl.read.biff.WorkbookParser Summary:
addSheet,   close,   containsMacros,   findByName,   findCellByName,   getAddInFunctionNames,   getButtonPropertySet,   getCell,   getCompoundFile,   getCountryRecord,   getDrawingGroup,   getExternalSheetIndex,   getExternalSheetIndex,   getExternalSheetName,   getExternalSheetRecord,   getFonts,   getFormattingRecords,   getIndex,   getLastExternalSheetIndex,   getLastExternalSheetIndex,   getLastExternalSheetName,   getMsoDrawingGroupRecord,   getName,   getNameIndex,   getNameRecords,   getNumberOfSheets,   getRangeNames,   getReadSheet,   getSettings,   getSheet,   getSheet,   getSheetNames,   getSheets,   getSupbookRecords,   getWorkbookBof,   getXCTRecords,   isProtected,   parse
Methods from jxl.Workbook:
close,   createWorkbook,   createWorkbook,   createWorkbook,   createWorkbook,   createWorkbook,   createWorkbook,   createWorkbook,   createWorkbook,   findByName,   findCellByName,   getCell,   getNumberOfSheets,   getRangeNames,   getSheet,   getSheet,   getSheetNames,   getSheets,   getVersion,   getWorkbook,   getWorkbook,   getWorkbook,   getWorkbook,   isProtected,   parse
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from jxl.read.biff.WorkbookParser Detail:
 final  void addSheet(Sheet s) 
    Adds the sheet to the end of the array
 public  void close() 
    Closes this workbook, and frees makes any memory allocated available for garbage collection
 public boolean containsMacros() 
    Accessor for the containsMacros
 public Range[] findByName(String name) 
    Gets the named range from this workbook. The Range object returns contains all the cells from the top left to the bottom right of the range. If the named range comprises an adjacent range, the Range[] will contain one object; for non-adjacent ranges, it is necessary to return an array of length greater than one. If the named range contains a single cell, the top left and bottom right cell will be the same cell
 public Cell findCellByName(String name) 
    Gets the named cell from this workbook. If the name refers to a range of cells, then the cell on the top left is returned. If the name cannot be found, null is returned
 public String[] getAddInFunctionNames() 
    Accessor for addin function names
 public ButtonPropertySetRecord getButtonPropertySet() 
    Accessor for the button property set, used during copying
 public Cell getCell(String loc) 
    Returns the cell for the specified location eg. "Sheet1!A4". This is identical to using the CellReferenceHelper with its associated performance overheads, consequently it should be use sparingly
 public CompoundFile getCompoundFile() 
    Accessor for the CompoundFile. For this feature to return non-null value, the propertySets feature in WorkbookSettings must be enabled and the workbook must contain additional property sets. This method is used during the workbook copy
 public CountryRecord getCountryRecord() 
    Accessor for the country record, using during copying
 public DrawingGroup getDrawingGroup() 
    Accessor for the drawing group
 public int getExternalSheetIndex(int index) 
    Package protected function which gets the real internal sheet index based upon the external sheet reference. This is used for extern sheet references which are specified in formulas
 public int getExternalSheetIndex(String sheetName) 
    Accessor/implementation method for the external sheet reference
 public String getExternalSheetName(int index) 
    Gets the name of the external sheet specified by the index
 public ExternalSheetRecord getExternalSheetRecord() 
    Accessor for the externSheet, used by the WritableWorkbook when creating a copy of this
 public Fonts getFonts() 
    Accessor for the fonts, used by the WritableWorkbook when creating a copy of this
 public FormattingRecords getFormattingRecords() 
    Accessor for the formattingRecords, used by the WritableWorkbook when creating a copy of this
 public int getIndex(Sheet sheet) 
    Gets the sheet index in this workbook. Used when importing a sheet
 public int getLastExternalSheetIndex(int index) 
    Package protected function which gets the real internal sheet index based upon the external sheet reference. This is used for extern sheet references which are specified in formulas
 public int getLastExternalSheetIndex(String sheetName) 
    Accessor/implementation method for the external sheet reference
 public String getLastExternalSheetName(int index) 
    Gets the name of the external sheet specified by the index
 public MsoDrawingGroupRecord getMsoDrawingGroupRecord() 
    Accessor for the MsoDrawingGroup, used by the WritableWorkbook when creating a copy of this
 public String getName(int index) throws NameRangeException 
    Gets the name at the specified index
 public int getNameIndex(String name) 
    Gets the index of the name record for the name
 public NameRecord[] getNameRecords() 
    Accessor for the name records. Used by the WritableWorkbook when creating a copy of this
 public int getNumberOfSheets() 
    Returns the number of sheets in this workbook
 public String[] getRangeNames() 
    Gets the named ranges
 public Sheet getReadSheet(int index) 
    Interface method from WorkbookMethods - gets the specified sheet within this workbook
 public WorkbookSettings getSettings() 
    Accessor for the settings
 public Sheet getSheet(int index) 
    Gets the specified sheet within this workbook
 public Sheet getSheet(String name) 
    Gets the sheet with the specified name from within this workbook
 public String[] getSheetNames() 
    Gets the sheet names
 public Sheet[] getSheets() 
    Gets the sheets within this workbook. NOTE: Use of this method for very large worksheets can cause performance and out of memory problems. Use the alternative method getSheet() to retrieve each sheet individually
 public SupbookRecord[] getSupbookRecords() 
    Accessor for the supbook records, used by the WritableWorkbook when creating a copy of this
 public BOFRecord getWorkbookBof() 
    Method used when parsing formulas to make sure we are trying to parse a supported biff version
 public XCTRecord[] getXCTRecords() 
 public boolean isProtected() 
    Determines whether the sheet is protected
 protected  void parse() throws BiffException, PasswordException 
    Does the hard work of building up the object graph from the excel bytes