svn commit: r1747671 - /poi/trunk/src/java/org/apache/poi/ss/usermodel/Table.java

[on...@apache.org]

Author: onealj
Date: Fri Jun 10 09:16:41 2016
New Revision: 1747671

URL: http://svn.apache.org/viewvc?rev=1747671&view=rev
Log:
fix javadocs

Modified:
    poi/trunk/src/java/org/apache/poi/ss/usermodel/Table.java

Modified: poi/trunk/src/java/org/apache/poi/ss/usermodel/Table.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/usermodel/Table.java?rev=1747671&r1=1747670&r2=1747671&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/usermodel/Table.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/usermodel/Table.java Fri Jun 10 09:16:41 2016
@@ -34,27 +34,28 @@ public interface Table {
     Pattern isStructuredReference = Pattern.compile("[a-zA-Z_\\\\][a-zA-Z0-9._]*\\[.*\\]");
     
     /**
-     *  Get the top-left col index
-     * @return
+     *  Get the top-left column index relative to the sheet
+     * @return table start column index on sheet
      */
     int getStartColIndex();
     /**
-     *  Get the top-left row index
-     * @return
+     *  Get the top-left row index on the sheet
+     * @return table start row index on sheet
      */
     int getStartRowIndex();
     /**
-     *  Get the bottom-right col index
-     * @return
+     *  Get the bottom-right column index on the sheet
+     * @return table end column index on sheet
      */
     int getEndColIndex();
     /**
      *  Get the bottom-right row index
-     * @return
+     * @return table end row index on sheet
      */
     int getEndRowIndex();
     /**
      * Get the name of the table.
+     * @return table name
      */
     String getName();
     
@@ -63,14 +64,16 @@ public interface Table {
      * Note this list is lazily loaded and cached for performance. 
      * Changes to the underlying table structure are not reflected in later calls
      * 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.
      */
     String getSheetName();
     /**
-     * Returns true iff the table has 'Totals' row
+     * Returns true iff the table has a 'Totals' row
      */
     boolean isHasTotalsRow();
     



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org