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.transform.components
Class AbstractTableComponent

java.lang.Object
  extended by com.ibm.hats.transform.components.Component
      extended by com.ibm.hats.transform.components.AbstractTableComponent
All Implemented Interfaces:
ICustomPropertySupplier
Direct Known Subclasses:
FieldTableComponent, TableComponent, TableHeaderComponent, VisualTableComponent

public abstract class AbstractTableComponent
extends Component


Field Summary
static String CLASS_NAME
           
static Properties defaults
           
static String PROPERTY_BETTER_FOUND_TABLE_HAS_BETTER_PARAMETER
           
static String PROPERTY_BETTER_FOUND_TABLE_HAS_LEAST
           
static String PROPERTY_CELL_BREAKS
           
static String PROPERTY_EXCLUDE_COLS
           
static String PROPERTY_EXCLUDE_ROWS
           
static String PROPERTY_INCLUDE_EMPTY_ROWS
           
static String PROPERTY_MIN_COLUMNS
           
static String PROPERTY_MIN_ROWS
           
static String PROPERTY_OVERRIDE_RENDERING_TYPE
           
static String PROPERTY_RENDER_BEHAVIOR_AS_DEFAULT
           
static String PROPERTY_RENDER_DEFAULT_AS_GUIDE
           
static String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_AREA
           
static String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_CELL_COUNT
           
static String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_COL_COUNT
           
static String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_FIRST
           
static String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_HEIGHT
           
static String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_SECOND
           
static String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_WIDTH
           
static String PROPERTY_TABLE_HIGHLIGHT_FIRST_ROW
           
static String PROPERTY_TABLE_HIGHLIGHT_PREVIOUS_ROW
           
static String SPREAD_SHEET_RECOGNIZE_REGION
           
 
Fields inherited from class com.ibm.hats.transform.components.Component
contextAttributes, flag, hostScreen
 
Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier
CLASSNAME
 
Constructor Summary
AbstractTableComponent(HsrScreen hostScreen)
           
 
Method Summary
protected  void assignSpreadsheetProperties(ComponentElement[] ce, ScreenRegion region, ContextAttributes contextAttributes, Properties settings)
           
protected  FieldComponentElement createEmptyFieldComponentElement(int startPos, int length)
           
 BlockScreenRegion[] createHeaderRegions(BlockScreenRegion area, BlockScreenRegion[] bsr, Properties settings, HsrScreen hs)
           
 void createTableCell(HsrScreen hs, int row, int col, int colpos, int nextbreak, int span, List rowcells)
           
 TableComponentElement createTableHeader(BlockScreenRegion bsr, Properties settings, HsrScreen hs, int maxheight, int mincols, int depth)
           
abstract  boolean evalCharIsBreak(int row, int col, HsrScreen hs, Properties settings)
           
 boolean evalFirstRegionIsBetterTable(BlockScreenRegion r1, BlockScreenRegion r2, HsrScreen hs, BlockScreenRegion search, int minrows, int mincols)
           
 boolean evalFirstRegionIsBetterTable(BlockScreenRegion r1, BlockScreenRegion r2, HsrScreen hs, BlockScreenRegion search, int minrows, int mincols, Properties settings)
           
 BlockScreenRegion[] findTables(BlockScreenRegion search, HsrScreen hs, Properties settings)
           
 ComponentElement[] findTables(Component component, BlockScreenRegion searcharea, HsrScreen hs, Properties settings)
           
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
 boolean handleCleaningOfSet(com.ibm.hats.common.NumberedSet ns, int d, int start, int end, int min)
           
 void handleRemovalFromSet(com.ibm.hats.common.NumberedSet ns, int d, int start, int end, int min)
           
 int[] modifyDepthTree(com.ibm.hats.common.NumberedSet ns, int[] depth, int shallowest, int deepest, int mincolbreaks, HsrScreen hs)
           
 ComponentElement[] previouslyRecognized(BlockScreenRegion region, Properties settings)
           
static void printIntArray(int[] b)
           
static void printNumberedSetTable(com.ibm.hats.common.NumberedSet[] ns, int width)
           
static void printNumberedSetTable(com.ibm.hats.common.NumberedSet[] ns, int width, int startrow, int endrow)
           
static void printNumberedSetTable(com.ibm.hats.common.NumberedSet[] ns, com.ibm.hats.common.NumberedSet[] orig, int width, int startrow, int endrow, HsrScreen hs, BlockScreenRegion bsr)
           
static void printNumberedSetTable(com.ibm.hats.common.NumberedSet ns, HsrScreen hs, BlockScreenRegion bsr)
           
static boolean protectedandspace(HsrScreen hs, int row, int col, int depth)
           
 ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region, Properties settings)
          Currently not implemented.
 void refactorBreaks(com.ibm.hats.common.NumberedSet colbreaks, BlockScreenRegion search, HsrScreen hs)
           
protected  BlockScreenRegion removeEmptyBottomRowsFromRegion(HsrScreen hs, BlockScreenRegion region)
           
 StringBuffer testTable(HsrScreen hs, BlockScreenRegion bsr, Properties settings, boolean defaultrender, ContextAttributes context)
           
 StringBuffer testTable(HsrScreen hs, BlockScreenRegion bsr, Properties settings, boolean defaultrender, Hashtable context)
          Deprecated.  
static void track(String s)
           
 
Methods inherited from class com.ibm.hats.transform.components.Component
convertPosToCol, convertPosToRow, convertRowColToPos, findFirstDelimiterIndex, findFirstIndexOf, findFirstIndexOf, findFirstIndexOf, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, getContextAttribute, getContextAttributes, getCustomComposite, getDefaultValues, getHostScreen, getPropertyPageCount, getTrailingSpaceCount, newInstance, recognize, recognize, setContextAttribute, setContextAttributes, setHostScreen
 
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

PROPERTY_INCLUDE_EMPTY_ROWS

public static final String PROPERTY_INCLUDE_EMPTY_ROWS
See Also:
Constant Field Values

PROPERTY_EXCLUDE_ROWS

public static final String PROPERTY_EXCLUDE_ROWS
See Also:
Constant Field Values

PROPERTY_EXCLUDE_COLS

public static final String PROPERTY_EXCLUDE_COLS
See Also:
Constant Field Values

PROPERTY_MIN_ROWS

public static final String PROPERTY_MIN_ROWS
See Also:
Constant Field Values

PROPERTY_MIN_COLUMNS

public static final String PROPERTY_MIN_COLUMNS
See Also:
Constant Field Values

PROPERTY_CELL_BREAKS

public static final String PROPERTY_CELL_BREAKS
See Also:
Constant Field Values

PROPERTY_TABLE_HIGHLIGHT_FIRST_ROW

public static final String PROPERTY_TABLE_HIGHLIGHT_FIRST_ROW
See Also:
Constant Field Values

PROPERTY_TABLE_HIGHLIGHT_PREVIOUS_ROW

public static final String PROPERTY_TABLE_HIGHLIGHT_PREVIOUS_ROW
See Also:
Constant Field Values

PROPERTY_OVERRIDE_RENDERING_TYPE

public static final String PROPERTY_OVERRIDE_RENDERING_TYPE
See Also:
Constant Field Values

PROPERTY_RENDER_BEHAVIOR_AS_DEFAULT

public static final String PROPERTY_RENDER_BEHAVIOR_AS_DEFAULT
See Also:
Constant Field Values

PROPERTY_RENDER_DEFAULT_AS_GUIDE

public static final String PROPERTY_RENDER_DEFAULT_AS_GUIDE
See Also:
Constant Field Values

PROPERTY_BETTER_FOUND_TABLE_HAS_BETTER_PARAMETER

public static final String PROPERTY_BETTER_FOUND_TABLE_HAS_BETTER_PARAMETER
See Also:
Constant Field Values

PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_CELL_COUNT

public static final String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_CELL_COUNT
See Also:
Constant Field Values

PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_COL_COUNT

public static final String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_COL_COUNT
See Also:
Constant Field Values

PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_HEIGHT

public static final String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_HEIGHT
See Also:
Constant Field Values

PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_WIDTH

public static final String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_WIDTH
See Also:
Constant Field Values

PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_AREA

public static final String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_AREA
See Also:
Constant Field Values

PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_FIRST

public static final String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_FIRST
See Also:
Constant Field Values

PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_SECOND

public static final String PROPERTY_TABLE_EVALUATION_SETTING_ABSTRACT_SECOND
See Also:
Constant Field Values

PROPERTY_BETTER_FOUND_TABLE_HAS_LEAST

public static final String PROPERTY_BETTER_FOUND_TABLE_HAS_LEAST
See Also:
Constant Field Values

SPREAD_SHEET_RECOGNIZE_REGION

public static final String SPREAD_SHEET_RECOGNIZE_REGION
See Also:
Constant Field Values

defaults

public static Properties defaults
Constructor Detail

AbstractTableComponent

public AbstractTableComponent(HsrScreen hostScreen)
Method Detail

getCustomProperties

public Vector getCustomProperties(int iPageNumber,
                                  Properties properties,
                                  ResourceBundle bundle)
Description copied from interface: ICustomPropertySupplier
Returns a list of this object's custom properties. Items must be of type com.ibm.hats.common.HCustomProperty.

Specified by:
getCustomProperties in interface ICustomPropertySupplier
Overrides:
getCustomProperties in class Component
Parameters:
iPageNumber - page number containing desired properties
properties - existing values for properties defined here
bundle - ResourceBundle containing NLS descriptions for the properties
Returns:
Vector containing all the custom properties for this object, or null if there are none
See Also:
HCustomProperty

handleRemovalFromSet

public void handleRemovalFromSet(com.ibm.hats.common.NumberedSet ns,
                                 int d,
                                 int start,
                                 int end,
                                 int min)

handleCleaningOfSet

public boolean handleCleaningOfSet(com.ibm.hats.common.NumberedSet ns,
                                   int d,
                                   int start,
                                   int end,
                                   int min)

refactorBreaks

public void refactorBreaks(com.ibm.hats.common.NumberedSet colbreaks,
                           BlockScreenRegion search,
                           HsrScreen hs)

modifyDepthTree

public int[] modifyDepthTree(com.ibm.hats.common.NumberedSet ns,
                             int[] depth,
                             int shallowest,
                             int deepest,
                             int mincolbreaks,
                             HsrScreen hs)

evalCharIsBreak

public abstract boolean evalCharIsBreak(int row,
                                        int col,
                                        HsrScreen hs,
                                        Properties settings)

createEmptyFieldComponentElement

protected FieldComponentElement createEmptyFieldComponentElement(int startPos,
                                                                 int length)

createTableCell

public void createTableCell(HsrScreen hs,
                            int row,
                            int col,
                            int colpos,
                            int nextbreak,
                            int span,
                            List rowcells)

recognize

public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
                                    Properties settings)
Description copied from class: Component
Currently not implemented.

This method must be implemented if the base class is subclassed.

Specified by:
recognize in class Component
See Also:
Component.recognize(LinearScreenRegion, Properties)

track

public static void track(String s)

previouslyRecognized

public ComponentElement[] previouslyRecognized(BlockScreenRegion region,
                                               Properties settings)

removeEmptyBottomRowsFromRegion

protected BlockScreenRegion removeEmptyBottomRowsFromRegion(HsrScreen hs,
                                                            BlockScreenRegion region)

findTables

public BlockScreenRegion[] findTables(BlockScreenRegion search,
                                      HsrScreen hs,
                                      Properties settings)

findTables

public ComponentElement[] findTables(Component component,
                                     BlockScreenRegion searcharea,
                                     HsrScreen hs,
                                     Properties settings)

protectedandspace

public static boolean protectedandspace(HsrScreen hs,
                                        int row,
                                        int col,
                                        int depth)

printIntArray

public static void printIntArray(int[] b)

printNumberedSetTable

public static void printNumberedSetTable(com.ibm.hats.common.NumberedSet[] ns,
                                         int width)

printNumberedSetTable

public static void printNumberedSetTable(com.ibm.hats.common.NumberedSet[] ns,
                                         int width,
                                         int startrow,
                                         int endrow)

printNumberedSetTable

public static void printNumberedSetTable(com.ibm.hats.common.NumberedSet ns,
                                         HsrScreen hs,
                                         BlockScreenRegion bsr)

printNumberedSetTable

public static void printNumberedSetTable(com.ibm.hats.common.NumberedSet[] ns,
                                         com.ibm.hats.common.NumberedSet[] orig,
                                         int width,
                                         int startrow,
                                         int endrow,
                                         HsrScreen hs,
                                         BlockScreenRegion bsr)

evalFirstRegionIsBetterTable

public boolean evalFirstRegionIsBetterTable(BlockScreenRegion r1,
                                            BlockScreenRegion r2,
                                            HsrScreen hs,
                                            BlockScreenRegion search,
                                            int minrows,
                                            int mincols)

evalFirstRegionIsBetterTable

public boolean evalFirstRegionIsBetterTable(BlockScreenRegion r1,
                                            BlockScreenRegion r2,
                                            HsrScreen hs,
                                            BlockScreenRegion search,
                                            int minrows,
                                            int mincols,
                                            Properties settings)

createHeaderRegions

public BlockScreenRegion[] createHeaderRegions(BlockScreenRegion area,
                                               BlockScreenRegion[] bsr,
                                               Properties settings,
                                               HsrScreen hs)

createTableHeader

public TableComponentElement createTableHeader(BlockScreenRegion bsr,
                                               Properties settings,
                                               HsrScreen hs,
                                               int maxheight,
                                               int mincols,
                                               int depth)

testTable

public StringBuffer testTable(HsrScreen hs,
                              BlockScreenRegion bsr,
                              Properties settings,
                              boolean defaultrender,
                              Hashtable context)
Deprecated. 


testTable

public StringBuffer testTable(HsrScreen hs,
                              BlockScreenRegion bsr,
                              Properties settings,
                              boolean defaultrender,
                              ContextAttributes context)

assignSpreadsheetProperties

protected void assignSpreadsheetProperties(ComponentElement[] ce,
                                           ScreenRegion region,
                                           ContextAttributes contextAttributes,
                                           Properties settings)

HATS 7.5.1 (201005110649)