fix javadocs

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1747671 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Javen O'Neal 2016-06-10 09:16:41 +00:00
parent 30dc1a4d30
commit bec8fbe92c

View File

@ -34,27 +34,28 @@ public interface Table {
Pattern isStructuredReference = Pattern.compile("[a-zA-Z_\\\\][a-zA-Z0-9._]*\\[.*\\]"); Pattern isStructuredReference = Pattern.compile("[a-zA-Z_\\\\][a-zA-Z0-9._]*\\[.*\\]");
/** /**
* Get the top-left col index * Get the top-left column index relative to the sheet
* @return * @return table start column index on sheet
*/ */
int getStartColIndex(); int getStartColIndex();
/** /**
* Get the top-left row index * Get the top-left row index on the sheet
* @return * @return table start row index on sheet
*/ */
int getStartRowIndex(); int getStartRowIndex();
/** /**
* Get the bottom-right col index * Get the bottom-right column index on the sheet
* @return * @return table end column index on sheet
*/ */
int getEndColIndex(); int getEndColIndex();
/** /**
* Get the bottom-right row index * Get the bottom-right row index
* @return * @return table end row index on sheet
*/ */
int getEndRowIndex(); int getEndRowIndex();
/** /**
* Get the name of the table. * Get the name of the table.
* @return table name
*/ */
String getName(); String getName();
@ -63,14 +64,16 @@ public interface Table {
* Note this list is lazily loaded and cached for performance. * Note this list is lazily loaded and cached for performance.
* Changes to the underlying table structure are not reflected in later calls * Changes to the underlying table structure are not reflected in later calls
* unless <code>XSSFTable.updateHeaders()</code> is called to reset the cache. * unless <code>XSSFTable.updateHeaders()</code> is called to reset the cache.
* @param columnHeader the column header name to get the table column index of
* @return column index corresponding to <code>columnHeader</code>
*/ */
int findColumnIndex(String column); int findColumnIndex(String columnHeader);
/** /**
* Returns the sheet name that the table belongs to. * Returns the sheet name that the table belongs to.
*/ */
String getSheetName(); String getSheetName();
/** /**
* Returns true iff the table has 'Totals' row * Returns true iff the table has a 'Totals' row
*/ */
boolean isHasTotalsRow(); boolean isHasTotalsRow();