HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.util
Class SpreadsheetFactory

java.lang.Object
  extended by com.ibm.hats.util.SpreadsheetFactory

public class SpreadsheetFactory
extends Object

The SpreadsheetFactory class gathers the necessary information for creating the spreadsheet file.


Field Summary
static String CLASS_NAME
           
 
Constructor Summary
SpreadsheetFactory(String tableCompName, String filetype, com.ibm.hats.common.Application app, HostScreen screen, ContextAttributes contextAttributes)
           
 
Method Summary
static void doSymSwap(StringBuffer s)
           
 String getColumnBreak()
           
static String reverseText(String text)
           
 void setColumnBreak(String columnBreak)
           
 void setExcludedRowCol(String excludedRows, String excludedCols)
           
 void setHeaderColumns(String[] headerColumns)
          Set the header data
 void setIncludeEmptyRows(boolean includeEmptyRows)
           
 void setIncludeEmptyRows(String includeEmptyRows)
           
 void setminRowCol(int minRows, int minCols)
          Set the minimum rows and columns.
 void setminRowCol(String minRows, String minCols)
           
 void setNumberOfTitleRows(int rows)
          Set the number of title row
 void setPreviousLineHeader(boolean previouslineheader)
           
 void setPreviousLineHeader(String previouslineheader)
           
 void setRegion(BlockScreenRegion region)
           
 void setTableIndex(int index)
           
 void setTableIndex(String index)
           
 ISpreadsheetContent spreadsheetCreator()
          Return the ISpreadsheetContent object by the factory information.
 ISpreadsheetContent spreadsheetCreator(boolean ltrOrientation, boolean dirText)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values
Constructor Detail

SpreadsheetFactory

public SpreadsheetFactory(String tableCompName,
                          String filetype,
                          com.ibm.hats.common.Application app,
                          HostScreen screen,
                          ContextAttributes contextAttributes)
Parameters:
tableCompName - table componment nam
filetype - indicate the generated file type. Current provide csv (ascii) and xls (binary) files.
app - HATS project object
screen - the current screen for recognizing and extracting the data
contextAttributes - the conditions for recognizing the table
Method Detail

setRegion

public void setRegion(BlockScreenRegion region)

spreadsheetCreator

public ISpreadsheetContent spreadsheetCreator()
Return the ISpreadsheetContent object by the factory information.

See Also:
ISpreadsheetContent

spreadsheetCreator

public ISpreadsheetContent spreadsheetCreator(boolean ltrOrientation,
                                              boolean dirText)

getColumnBreak

public String getColumnBreak()
Returns:
Returns the columnBreak.

setColumnBreak

public void setColumnBreak(String columnBreak)
Parameters:
columnBreak - The columnBreak to set.

setIncludeEmptyRows

public void setIncludeEmptyRows(String includeEmptyRows)
Parameters:
includeEmptyRows - The includeEmptyRows to set.

setIncludeEmptyRows

public void setIncludeEmptyRows(boolean includeEmptyRows)
Parameters:
includeEmptyRows - The includeEmptyRows to set.

setExcludedRowCol

public void setExcludedRowCol(String excludedRows,
                              String excludedCols)
Parameters:
excludedRows - The excludedRows to set
excludedCols - The excludedCols to set

setPreviousLineHeader

public void setPreviousLineHeader(String previouslineheader)
Parameters:
previouslineheader - The PreviousLineHeader to set.

setPreviousLineHeader

public void setPreviousLineHeader(boolean previouslineheader)
Parameters:
previouslineheader - The PreviousLineHeader to set.

setTableIndex

public void setTableIndex(String index)
Parameters:
index - The tableIndex to set.

setTableIndex

public void setTableIndex(int index)
Parameters:
index - The tableIndex to set.

setminRowCol

public void setminRowCol(String minRows,
                         String minCols)
Parameters:
minRows - The minimun rows to set.
minCols - The minimun columns to set.

setminRowCol

public void setminRowCol(int minRows,
                         int minCols)
Set the minimum rows and columns.

Parameters:
minRows - The minimum rows to set.
minCols - The minimum columns to set.

setHeaderColumns

public void setHeaderColumns(String[] headerColumns)
Set the header data

Parameters:
headerColumns - the header data.

setNumberOfTitleRows

public void setNumberOfTitleRows(int rows)
Set the number of title row

Parameters:
rows - The number of title row to set

reverseText

public static String reverseText(String text)

doSymSwap

public static void doSymSwap(StringBuffer s)

HATS 7.5.1 (201005110649)