* a static id matching one that you have registered in your HSSFRequest will be passed
* to your associated HSSFListener.
*
- * @see org.apache.poi.hssf.dev.EFHSSF
- *
* @author Andrew C. Oliver (acoliver at apache dot org)
* @author Carey Sublette (careysub@earthling.net)
*/
* Processes a file into essentially record events.
*
* @param req an Instance of HSSFRequest which has your registered listeners
- * @param fs a POIFS filesystem containing your workbook
+ * @param dir a DirectoryNode containing your workbook
*/
public void processWorkbookEvents(HSSFRequest req, DirectoryNode dir) throws IOException {
InputStream in = dir.createDocumentInputStream("Workbook");
* Processes a file into essentially record events.
*
* @param req an Instance of HSSFRequest which has your registered listeners
- * @param fs a POIFS filesystem containing your workbook
+ * @param dir a DirectoryNode containing your workbook
* @return numeric user-specified result code.
*/
public short abortableProcessWorkbookEvents(HSSFRequest req, DirectoryNode dir)
*
* @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
* @see org.apache.poi.hssf.eventusermodel.HSSFListener
- * @see org.apache.poi.hssf.dev.EFHSSF
* @see org.apache.poi.hssf.eventusermodel.HSSFUserException
* @author Andrew C. Oliver (acoliver at apache dot org)
* @author Carey Sublette (careysub@earthling.net)
* Indicates that the defined name refers to a user-defined function.
* This attribute is used when there is an add-in or other code project associated with the file.
*
- * @param value <code>true</code> indicates the name refers to a function.
+ * @param function <code>true</code> indicates the name refers to a function.
*/
public void setFunction(boolean function){
if (function) {
}
/**
- @requrn sid of next record. Can be called after hasNextRecord()
+ @return sid of next record. Can be called after hasNextRecord()
*/
public int getNextSid() {
return _nextSid;
}
/**
- * @param firstCells
- * @param recs list of sheet records (possibly contains records for other parts of the Excel file)
- * @param startIx index of first row/cell record for current sheet
- * @param endIx one past index of last row/cell record for current sheet. It is important
- * that this code does not inadvertently collect <tt>SharedFormulaRecord</tt>s from any other
- * sheet (which could happen if endIx is chosen poorly). (see bug 44449)
*/
public static SharedValueManager create(SharedFormulaRecord[] sharedFormulaRecords,
CellReference[] firstCells, ArrayRecord[] arrayRecords, TableRecord[] tableRecords) {
* <P>
* This record part specifies Formula Evaluation & Error Ignoring data
* for a sheet, stored as part of a Shared Feature. It can be found in
- * records such as {@link FeatRecord}, {@link Feat11Record} or
- * {@link Feat12Record}.
+ * records such as {@link FeatRecord}.
* For the full meanings of the flags, see pages 669 and 670
* of the Excel binary file format documentation.
*/
* <P>
* This record part specifies Protection data for a sheet, stored
* as part of a Shared Feature. It can be found in records such
- * as {@link FeatRecord}, {@link Feat11Record} or
- * {@link Feat12Record}
+ * as {@link FeatRecord}
*/
public final class FeatProtection implements SharedFeature {
public static long NO_SELF_RELATIVE_SECURITY_FEATURE = 0;
* Title: FeatSmartTag (Smart Tag Shared Feature) common record part
* <P>
* This record part specifies Smart Tag data for a sheet, stored as part
- * of a Shared Feature. It can be found in records such as
- * {@link FeatRecord}, {@link Feat11Record} or {@link Feat12Record}.
+ * of a Shared Feature. It can be found in records such as {@link FeatRecord}.
* It is made up of a hash, and a set of Factoid Data that makes up
* the smart tags.
* For more details, see page 669 of the Excel binary file
* <tt>start_num</tt>, is optional (default=1) and specifies where to start searching
* from. Character positions are 1-based.<p/>
*
- * @author Torstein Tauno Svendsen (torstei@officenet.no)
+ * Author: Torstein Tauno Svendsen (torstei@officenet.no)
*/
public static final Function FIND = new SearchFind(true);
/**
* Get the format index that matches the given format
* string, creating a new format entry if required.
* Aliases text to the proper format as required.
- * @param format string matching a built in format
+ * @param pFormat string matching a built in format
* @return index of format.
*/
public short getFormat(String pFormat) {
* Constructor RawDataBlock
*
* @param stream the InputStream from which the data will be read
- * @param blockSize the size of the POIFS blocks, normally 512 bytes {@link POIFSConstants#BIG_BLOCK_SIZE}
+ * @param blockSize the size of the POIFS blocks, normally 512 bytes
+ * {@link org.apache.poi.poifs.common.POIFSConstants#SMALLER_BIG_BLOCK_SIZE}
*
* @exception IOException on I/O errors, and if an insufficient
* amount of data is read (the InputStream must
/**
* This is the abstract supertype for the various cell formatters.
*
- * @@author Ken Arnold, Industrious Media LLC
+ * @author Ken Arnold, Industrious Media LLC
*/
public abstract class CellFormatter {
/** The original specified format. */
import org.apache.poi.hssf.record.formula.eval.ValueEval;
/**
- * Common interface of {@link AreaEval} and {@link ArrayEval}
+ * Common interface of {@link AreaEval} and {@link org.apache.poi.hssf.record.formula.eval.AreaEvalBase}
*
* @author Josh Micich
*/
* evaluateInCell() when the call should not modify the contents of the
* original cell.
*
- * @param cell may be <code>null</code> signifying that the cell is not present (or blank)
+ * @param sheetName the name of the sheet containing the cell
+ * @param rowIndex zero based
+ * @param columnIndex zero based
* @return <code>null</code> if the supplied cell is <code>null</code> or blank
*/
public ValueEval evaluate(String sheetName, int rowIndex, int columnIndex) {
* <p/>
* Automatically converts "text" to excel's format string to represent text.
* </p>
- * @param fmt string matching a built-in format
+ * @param pFmt string matching a built-in format
* @return index of format or -1 if undefined.
*/
public static int getBuiltinFormat(String pFmt) {
}
/**
- * Gets the CTSchema buy it's ID
+ * Gets the
* @param schemaId the schema ID
- * @return
+ * @return CTSchema by it's ID
*/
public CTSchema getCTSchemaById(String schemaId){
CTSchema xmlSchema = null;
}
/**
- * the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4)
- * @return
+ * @return the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4)
*/
public long getNumerOfMappedColumns(){
return ctTable.getTableColumns().getCount();
/**
- * The reference for the cell in the top-left part of the table
+ * @return The reference for the cell in the top-left part of the table
* (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
- * @return
+ *
*/
public CellReference getStartCellReference() {
}
/**
- * The reference for the cell in the bottom-right part of the table
+ * @return The reference for the cell in the bottom-right part of the table
* (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
- * @return
+ *
*/
public CellReference getEndCellReference() {
/**
- * Gets the total number of rows in the selection. (Note: in this version autofiltering is ignored)
- * @return
+ * @return the total number of rows in the selection. (Note: in this version autofiltering is ignored)
+ *
*/
public int getRowCount(){
}
/**
- * Gets the style of the paragraph
- * @return
+ * @return the style of the paragraph
*/
public String getStyle() {
CTPPr pr = getCTPPr();
}
/**
* Constructor for reading MSG Files from a POIFS filesystem
- * @param in
+ * @param fs
* @throws IOException
*/
public MAPIMessage(POIFSFileSystem fs) throws IOException {
/**
* Constructor for reading MSG Files from a certain
* point within a POIFS filesystem
- * @param in
+ * @param poifsDir
+ * @param fs
* @throws IOException
*/
public MAPIMessage(DirectoryNode poifsDir, POIFSFileSystem fs) throws IOException {
* If your data isn't in fact stored as basically
* ASCII, don't expect this to return much of any
* sense....
- * @return
+ * @return the data formatted as a string
*/
public String getAs7bitString() {
return StringChunk.parseAs7BitData(value);
}
/**
- * Returns the date that the server accepted the
+ * @return the date that the server accepted the
* message, as found from the message ID it generated.
- * @return
+ *
*/
public Calendar getAcceptedAtTime() {
return date;
}
/**
- * Returns the full ID that the server generated when
+ * @return the full ID that the server generated when
* it accepted the message.
*/
public String getSubmissionId() {
}
/**
- * the criteria arg is mostly handled by {@link OperandResolver#getSingleValue(Eval, int, short)}
+ * the criteria arg is mostly handled by {@link OperandResolver#getSingleValue(org.apache.poi.hssf.record.formula.eval.ValueEval, int, int)}}
*/
public void testCountifAreaCriteria() {
int srcColIx = 2; // anything but column A
import org.apache.poi.ss.usermodel.CellValue;
/**
- * Tests for {@link Find}
+ * Tests for {@link Financed}
*
* @author Torstein Svendsen (torstei@officenet.no)
*/
projects / poi.git / commitdiff