Merged revisions 638786-638802,638805-638811,638813-638814,638816-639230,639233-639241,639243-639253,639255-639486,639488-639601,639603-639835,639837-639917,639919-640056,640058-640710,640712-641156,641158-641184,641186-641795,641797-641798,641800-641933,641935-641963,641965-641966,641968-641995,641997-642230,642232-642562,642564-642565,642568-642570,642572-642573,642576-642736,642739-642877,642879,642881-642890,642892-642903,642905-642945,642947-643624,643626-643653,643655-643669,643671,643673-643830,643832-643833,643835-644342,644344-644472,644474-644508,644510-645347,645349-645351,645353-645559,645561-645565,645568-645951,645953-646193,646195-646311,646313-646404,646406-646665,646667-646853,646855-646869,646871-647151,647153-647185,647187-647277,647279-647566,647568-647573,647575,647578-647711,647714-647737,647739-647823,647825-648155,648157-648202,648204-648273,648275,648277-648302,648304-648333,648335-648588,648590-648622,648625-648673,648675-649141,649144,649146-649556,649558-649795,649799,649801-649910,649912-649913,649915-650128,650131-650132,650134-650137,650140-650914,650916-651991,651993-652284,652286-652287,652289,652291,652293-652297,652299-652328,652330-652425,652427-652445,652447-652560,652562-652933,652935,652937-652993,652995-653116,653118-653124,653126-653483,653487-653519,653522-653550,653552-653607,653609-653667,653669-653674,653676-653814,653817-653830,653832-653891,653893-653944,653946-654055,654057-654355,654357-654365,654367-654648,654651-655215,655217-655277,655279-655281,655283-655911,655913-656212,656214,656216-656251,656253-656698,656700-656756,656758-656892,656894-657135,657137-657165,657168-657179,657181-657354,657356-657357,657359-657701,657703-657874,657876-658032,658034-658284,658286,658288-658301,658303-658307,658309-658321,658323-658335,658337-658348,658351,658353-658832,658834-658983,658985,658987-659066,659068-659402,659404-659428,659430-659451,659453-659454,659456-659461,659463-659477,659479-659524,659526-659571,659574,659576-660255,660257-660262,660264-660279,660281-660343,660345-660473,660475-660827,660829-660833,660835-660888,660890-663321,663323-663435,663437-663764,663766-663854,663856-664219,664221-664489,664494-664514,664516-668013,668015-668142,668144-668152,668154,668156-668256,668258,668260-669139,669141-669455,669457-669657,669659-669808,669810-670189,670191-671321,671323-672229,672231-672549,672551-672552,672554-672561,672563-672566,672568,672571-673049,673051-673852,673854-673862,673864-673986,673988-673996,673998-674347,674349-674890,674892-674910,674912-674936,674938-674952,674954-675078,675080-675085,675087-675217,675219-675660,675662-675670,675672-675716,675718-675726,675728-675733,675735-675775,675777-675782,675784,675786-675791,675794-675852,675854-676200,676202,676204,676206-676220,676222-676309,676311-676456,676458-676994,676996-677027,677030-677040,677042-677056,677058-677375,677377-677968,677970-677971,677973,677975-677994,677996-678286,678288-678538,678540-680393,680395-680469,680471-680529,680531-680852,680854-681529,681531-681571,681573-682224,682226,682228,682231-682281,682283-682335,682337-682507,682509,682512-682517,682519-682532,682534-682619,682622-682777,682779-682998,683000-683019,683021-683022,683024-683080,683082-683092,683094-683095,683097-683127,683129-683131,683133-683166,683168-683698,683700-683705,683707-683757,683759-683787,683789-683870,683872-683879,683881-683900,683902-684213 via svnmerge from

https://svn.apache.org/repos/asf/poi/trunk

........
  r684067 | josh | 2008-08-08 20:49:02 +0100 (Fri, 08 Aug 2008) | 1 line
  
  Standardised toString methods on ScalarConstantPtg subclasses
........
  r684075 | josh | 2008-08-08 21:14:24 +0100 (Fri, 08 Aug 2008) | 1 line
  
  improved error message for FormulaParser when the formula has a leading equals sign
........


git-svn-id: https://svn.apache.org/repos/asf/poi/branches/ooxml@684216 13f79535-47bb-0310-9956-ffa450edef68

8 files changed, 60 insertions, 83 deletions

diff --git a/src/java/org/apache/poi/hssf/model/FormulaParser.java b/src/java/org/apache/poi/hssf/model/FormulaParser.java
index eb3f2ad6ca..d72d08eeaf 100644
--- a/src/java/org/apache/poi/hssf/model/FormulaParser.java
+++ b/src/java/org/apache/poi/hssf/model/FormulaParser.java
@@ -20,7 +20,6 @@ package org.apache.poi.hssf.model;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Stack;
-import java.util.regex.Pattern;
 
 //import PTGs .. since we need everything, import *
 import org.apache.poi.hssf.record.formula.*;
@@ -138,9 +137,16 @@ public final class FormulaParser {
 
     /** Report What Was Expected */
     private RuntimeException expected(String s) {
-        String msg = "Parse error near char " + (pointer-1) + " '" + look + "'"
-            + " in specified formula '" + formulaString + "'. Expected "
-            + s;
+        String msg;
+        
+        if (look == '=' && formulaString.substring(0, pointer-1).trim().length() < 1) {
+            msg = "The specified formula '" + formulaString 
+                + "' starts with an equals sign which is not allowed.";
+        } else {
+            msg = "Parse error near char " + (pointer-1) + " '" + look + "'"
+                + " in specified formula '" + formulaString + "'. Expected "
+                + s;
+        }
         return new FormulaParseException(msg);
     }
 
diff --git a/src/java/org/apache/poi/hssf/record/formula/BoolPtg.java b/src/java/org/apache/poi/hssf/record/formula/BoolPtg.java
index 3d9c496604..ae2fd541cc 100644
--- a/src/java/org/apache/poi/hssf/record/formula/BoolPtg.java
+++ b/src/java/org/apache/poi/hssf/record/formula/BoolPtg.java
@@ -17,7 +17,6 @@
 
 package org.apache.poi.hssf.record.formula;
 
-import org.apache.poi.ss.usermodel.Workbook;
 import org.apache.poi.hssf.record.RecordInputStream;
 
 /**
@@ -30,36 +29,30 @@ import org.apache.poi.hssf.record.RecordInputStream;
 public final class BoolPtg extends ScalarConstantPtg {
     public final static int  SIZE = 2;
     public final static byte sid  = 0x1d;
-    private final boolean field_1_value;
+    private final boolean _value;
 
-    public BoolPtg(RecordInputStream in)
-    {
-        field_1_value = (in.readByte() == 1);
+    public BoolPtg(RecordInputStream in) {
+        _value = (in.readByte() == 1);
     }
 
-
     public BoolPtg(String formulaToken) {
-        field_1_value = (formulaToken.equals("TRUE"));
+        _value = (formulaToken.equalsIgnoreCase("TRUE"));
     }
 
-    public boolean getValue()
-    {
-        return field_1_value;
+    public boolean getValue() {
+        return _value;
     }
 
-    public void writeBytes(byte [] array, int offset)
-    {
+    public void writeBytes(byte [] array, int offset) {
         array[ offset + 0 ] = sid;
-        array[ offset + 1 ] = (byte) (field_1_value ? 1 : 0);
+        array[ offset + 1 ] = (byte) (_value ? 1 : 0);
     }
 
-    public int getSize()
-    {
+    public int getSize() {
         return SIZE;
     }
 
-    public String toFormulaString(Workbook book)
-    {
-        return field_1_value ? "TRUE" : "FALSE";
+    protected String toFormulaString() {
+        return _value ? "TRUE" : "FALSE";
     }
 }
diff --git a/src/java/org/apache/poi/hssf/record/formula/ErrPtg.java b/src/java/org/apache/poi/hssf/record/formula/ErrPtg.java
index 27a2b29de5..aef580d5e4 100644
--- a/src/java/org/apache/poi/hssf/record/formula/ErrPtg.java
+++ b/src/java/org/apache/poi/hssf/record/formula/ErrPtg.java
@@ -17,7 +17,6 @@
 
 package org.apache.poi.hssf.record.formula;
 
-import org.apache.poi.ss.usermodel.Workbook;
 import org.apache.poi.hssf.record.RecordInputStream;
 import org.apache.poi.hssf.usermodel.HSSFErrorConstants;
 
@@ -68,7 +67,7 @@ public final class ErrPtg extends ScalarConstantPtg {
         array[offset + 1] = (byte)field_1_error_code;
     }
 
-    public String toFormulaString(Workbook book) {
+    protected String toFormulaString() {
         return HSSFErrorConstants.getText(field_1_error_code);
     }
 
diff --git a/src/java/org/apache/poi/hssf/record/formula/IntPtg.java b/src/java/org/apache/poi/hssf/record/formula/IntPtg.java
index 609b3ea451..c4abb7b1bc 100644
--- a/src/java/org/apache/poi/hssf/record/formula/IntPtg.java
+++ b/src/java/org/apache/poi/hssf/record/formula/IntPtg.java
@@ -17,9 +17,8 @@
 
 package org.apache.poi.hssf.record.formula;
 
-import org.apache.poi.util.LittleEndian;
-import org.apache.poi.ss.usermodel.Workbook;
 import org.apache.poi.hssf.record.RecordInputStream;
+import org.apache.poi.util.LittleEndian;
 
 /**
  * Integer (unsigned short integer)
@@ -60,8 +59,7 @@ public final class IntPtg extends ScalarConstantPtg {
         return field_1_value;
     }
 
-    public void writeBytes(byte [] array, int offset)
-    {
+    public void writeBytes(byte [] array, int offset) {
         array[ offset + 0 ] = sid;
         LittleEndian.putUShort(array, offset + 1, getValue());
     }
@@ -70,15 +68,7 @@ public final class IntPtg extends ScalarConstantPtg {
         return SIZE;
     }
 
-    public String toFormulaString(Workbook book) {
+    protected String toFormulaString() {
         return String.valueOf(getValue());
     }
-
-    public String toString() {
-        StringBuffer sb = new StringBuffer(64);
-        sb.append(getClass().getName()).append(" [");
-        sb.append(field_1_value);
-        sb.append("]");
-        return sb.toString();
-    }
 }
diff --git a/src/java/org/apache/poi/hssf/record/formula/MissingArgPtg.java b/src/java/org/apache/poi/hssf/record/formula/MissingArgPtg.java
index 19f56cff74..ffcf423b4f 100644
--- a/src/java/org/apache/poi/hssf/record/formula/MissingArgPtg.java
+++ b/src/java/org/apache/poi/hssf/record/formula/MissingArgPtg.java
@@ -17,8 +17,6 @@
 
 package org.apache.poi.hssf.record.formula;
 
-import org.apache.poi.ss.usermodel.Workbook;
-
 /**
  * Missing Function Arguments
  *
@@ -31,22 +29,20 @@ public final class MissingArgPtg extends ScalarConstantPtg {
     public final static byte sid  = 0x16;
    
     public static final Ptg instance = new MissingArgPtg();
-    private MissingArgPtg()
-    {
+
+    private MissingArgPtg() {
+    	// enforce singleton
     }
      
-    public void writeBytes(byte [] array, int offset)
-    {
+    public void writeBytes(byte [] array, int offset) {
         array[ offset + 0 ] = sid;
     }
 
-    public int getSize()
-    {
+    public int getSize() {
         return SIZE;
     }
    
-    public String toFormulaString(Workbook book)
-    {
+    protected String toFormulaString() {
         return " ";
     }
 }
diff --git a/src/java/org/apache/poi/hssf/record/formula/NumberPtg.java b/src/java/org/apache/poi/hssf/record/formula/NumberPtg.java
index f02275860c..d7f7195e05 100644
--- a/src/java/org/apache/poi/hssf/record/formula/NumberPtg.java
+++ b/src/java/org/apache/poi/hssf/record/formula/NumberPtg.java
@@ -17,9 +17,8 @@
 
 package org.apache.poi.hssf.record.formula;
 
-import org.apache.poi.util.LittleEndian;
-import org.apache.poi.ss.usermodel.Workbook;
 import org.apache.poi.hssf.record.RecordInputStream;
+import org.apache.poi.util.LittleEndian;
 
 /**
  * Number
@@ -34,8 +33,7 @@ public final class NumberPtg extends ScalarConstantPtg {
     private final double field_1_value;
         
     /** Create a NumberPtg from a byte array read from disk */
-    public NumberPtg(RecordInputStream in)
-    {
+    public NumberPtg(RecordInputStream in) {
         this(in.readDouble());
     }
     
@@ -52,33 +50,22 @@ public final class NumberPtg extends ScalarConstantPtg {
         field_1_value = value;
     }
     
-    public double getValue()
-    {
+    public double getValue() {
         return field_1_value;
     }
 
-    public void writeBytes(byte [] array, int offset)
-    {
+    public void writeBytes(byte [] array, int offset) {
         array[ offset + 0 ] = sid;
         LittleEndian.putDouble(array, offset + 1, getValue());
     }
 
-    public int getSize()
-    {
+    public int getSize() {
         return SIZE;
     }
 
-    public String toFormulaString(Workbook book)
-    {
+    protected String toFormulaString() {
         // TODO - java's rendering of double values is not quite same as excel's
+        // Maybe use HSSFDataFormatter?
         return String.valueOf(field_1_value);
     }
-    
-    public String toString() {
-        StringBuffer sb = new StringBuffer(64);
-        sb.append(getClass().getName()).append(" [");
-        sb.append(field_1_value);
-        sb.append("]");
-        return sb.toString();
-    }
 }
diff --git a/src/java/org/apache/poi/hssf/record/formula/ScalarConstantPtg.java b/src/java/org/apache/poi/hssf/record/formula/ScalarConstantPtg.java
index 8b00d327fc..bb1613c9ac 100644
--- a/src/java/org/apache/poi/hssf/record/formula/ScalarConstantPtg.java
+++ b/src/java/org/apache/poi/hssf/record/formula/ScalarConstantPtg.java
@@ -17,6 +17,8 @@
 

 package org.apache.poi.hssf.record.formula;

 

+import org.apache.poi.ss.usermodel.Workbook;

+

 /**

  * @author Josh Micich

  */

@@ -24,7 +26,22 @@ abstract class ScalarConstantPtg extends Ptg {
 	public boolean isBaseToken() {

 		return true;

 	}

-    public final byte getDefaultOperandClass() {

-        return Ptg.CLASS_VALUE;

-    }

+

+	public final byte getDefaultOperandClass() {

+		return Ptg.CLASS_VALUE;

+	}

+

+	public final String toFormulaString(Workbook book) {

+		return toFormulaString();

+	}

+

+	protected abstract String toFormulaString();

+

+	public final String toString() {

+		StringBuffer sb = new StringBuffer(64);

+		sb.append(getClass().getName()).append(" [");

+		sb.append(toFormulaString());

+		sb.append("]");

+		return sb.toString();

+	}

 }

diff --git a/src/java/org/apache/poi/hssf/record/formula/StringPtg.java b/src/java/org/apache/poi/hssf/record/formula/StringPtg.java
index 88b4d9843d..7007b48fdb 100644
--- a/src/java/org/apache/poi/hssf/record/formula/StringPtg.java
+++ b/src/java/org/apache/poi/hssf/record/formula/StringPtg.java
@@ -17,11 +17,10 @@
 
 package org.apache.poi.hssf.record.formula;
 
-import org.apache.poi.ss.usermodel.Workbook;
+import org.apache.poi.hssf.record.RecordInputStream;
 import org.apache.poi.util.BitField;
 import org.apache.poi.util.BitFieldFactory;
 import org.apache.poi.util.StringUtil;
-import org.apache.poi.hssf.record.RecordInputStream;
 
 /**
  * String Stores a String value in a formula value stored in the format
@@ -55,8 +54,6 @@ public final class StringPtg extends ScalarConstantPtg {
         } else {
             field_3_string = in.readCompressedUnicode(field_1_length);
         }
-
-        // setValue(new String(data, offset+3, data[offset+1] + 256*data[offset+2]));
     }
 
     /**
@@ -100,7 +97,7 @@ public final class StringPtg extends ScalarConstantPtg {
         }
     }
 
-    public String toFormulaString(Workbook book) {
+    protected String toFormulaString() {
         String value = field_3_string;
         int len = value.length();
         StringBuffer sb = new StringBuffer(len + 4);
@@ -117,12 +114,4 @@ public final class StringPtg extends ScalarConstantPtg {
         sb.append(FORMULA_DELIMITER);
         return sb.toString();
     }
-
-    public String toString() {
-        StringBuffer sb = new StringBuffer(64);
-        sb.append(getClass().getName()).append(" [");
-        sb.append(field_3_string);
-        sb.append("]");
-        return sb.toString();
-    }
 }