From 00129c4158de2e27480aa7881f257490c5fe7191 Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Mon, 13 Jul 2015 18:38:15 +0000 Subject: [PATCH] Begin updating the HSSF CF code to work on the base types, so it can handle both CF and CF12 git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1690793 13f79535-47bb-0310-9956-ffa450edef68 --- .../record/aggregates/CFRecordsAggregate.java | 83 ++++++++++++++----- .../hssf/usermodel/HSSFBorderFormatting.java | 6 +- .../usermodel/HSSFConditionalFormatting.java | 4 +- .../HSSFConditionalFormattingRule.java | 7 +- .../hssf/usermodel/HSSFFontFormatting.java | 5 +- .../hssf/usermodel/HSSFPatternFormatting.java | 6 +- .../HSSFSheetConditionalFormatting.java | 5 +- .../aggregates/TestCFRecordsAggregate.java | 27 ++++++ 8 files changed, 104 insertions(+), 39 deletions(-) diff --git a/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java index 85edcae21d..d6da4f686d 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java @@ -21,7 +21,11 @@ import java.util.ArrayList; import java.util.List; import org.apache.poi.hssf.model.RecordStream; +import org.apache.poi.hssf.record.CFHeader12Record; +import org.apache.poi.hssf.record.CFHeaderBase; import org.apache.poi.hssf.record.CFHeaderRecord; +import org.apache.poi.hssf.record.CFRule12Record; +import org.apache.poi.hssf.record.CFRuleBase; import org.apache.poi.hssf.record.CFRuleRecord; import org.apache.poi.hssf.record.Record; import org.apache.poi.ss.formula.FormulaShifter; @@ -45,12 +49,12 @@ public final class CFRecordsAggregate extends RecordAggregate { private static final int MAX_97_2003_CONDTIONAL_FORMAT_RULES = 3; private static final POILogger logger = POILogFactory.getLogger(CFRecordsAggregate.class); - private final CFHeaderRecord header; + private final CFHeaderBase header; /** List of CFRuleRecord objects */ - private final List rules; + private final List rules; - private CFRecordsAggregate(CFHeaderRecord pHeader, CFRuleRecord[] pRules) { + private CFRecordsAggregate(CFHeaderBase pHeader, CFRuleBase[] pRules) { if(pHeader == null) { throw new IllegalArgumentException("header must not be null"); } @@ -67,14 +71,21 @@ public final class CFRecordsAggregate extends RecordAggregate { throw new RuntimeException("Mismatch number of rules"); } header = pHeader; - rules = new ArrayList(3); + rules = new ArrayList(pRules.length); for (int i = 0; i < pRules.length; i++) { + checkRuleType(pRules[i]); rules.add(pRules[i]); } } - public CFRecordsAggregate(CellRangeAddress[] regions, CFRuleRecord[] rules) { - this(new CFHeaderRecord(regions, rules.length), rules); + public CFRecordsAggregate(CellRangeAddress[] regions, CFRuleBase[] rules) { + this(createHeader(regions, rules), rules); + } + private static CFHeaderBase createHeader(CellRangeAddress[] regions, CFRuleBase[] rules) { + if (rules.length == 0 || rules[0] instanceof CFRuleRecord) { + return new CFHeaderRecord(regions, rules.length); + } + return new CFHeader12Record(regions, rules.length); } /** @@ -84,17 +95,19 @@ public final class CFRecordsAggregate extends RecordAggregate { */ public static CFRecordsAggregate createCFAggregate(RecordStream rs) { Record rec = rs.getNext(); - if (rec.getSid() != CFHeaderRecord.sid) { + if (rec.getSid() != CFHeaderRecord.sid && + rec.getSid() != CFHeader12Record.sid) { throw new IllegalStateException("next record sid was " + rec.getSid() - + " instead of " + CFHeaderRecord.sid + " as expected"); + + " instead of " + CFHeaderRecord.sid + " or " + + CFHeader12Record.sid + " as expected"); } - CFHeaderRecord header = (CFHeaderRecord)rec; + CFHeaderBase header = (CFHeaderBase)rec; int nRules = header.getNumberOfConditionalFormats(); - CFRuleRecord[] rules = new CFRuleRecord[nRules]; + CFRuleBase[] rules = new CFRuleBase[nRules]; for (int i = 0; i < rules.length; i++) { - rules[i] = (CFRuleRecord) rs.getNext(); + rules[i] = (CFRuleBase) rs.getNext(); } return new CFRecordsAggregate(header, rules); @@ -105,18 +118,17 @@ public final class CFRecordsAggregate extends RecordAggregate { */ public CFRecordsAggregate cloneCFAggregate() { - - CFRuleRecord[] newRecs = new CFRuleRecord[rules.size()]; + CFRuleBase[] newRecs = new CFRuleBase[rules.size()]; for (int i = 0; i < newRecs.length; i++) { newRecs[i] = (CFRuleRecord) getRule(i).clone(); } - return new CFRecordsAggregate((CFHeaderRecord) header.clone(), newRecs); + return new CFRecordsAggregate((CFHeaderBase)header.clone(), newRecs); } /** * @return the header. Never null. */ - public CFHeaderRecord getHeader() + public CFHeaderBase getHeader() { return header; } @@ -127,18 +139,31 @@ public final class CFRecordsAggregate extends RecordAggregate { + ") nRules=" + rules.size()); } } - public CFRuleRecord getRule(int idx) { + private void checkRuleType(CFRuleBase r) { + if (header instanceof CFHeaderRecord && + r instanceof CFRuleRecord) { + return; + } + if (header instanceof CFHeader12Record && + r instanceof CFRule12Record) { + return; + } + throw new IllegalArgumentException("Header and Rule must both be CF or both be CF12, can't mix"); + } + + public CFRuleBase getRule(int idx) { checkRuleIndex(idx); return rules.get(idx); } - public void setRule(int idx, CFRuleRecord r) { + public void setRule(int idx, CFRuleBase r) { if (r == null) { throw new IllegalArgumentException("r must not be null"); } checkRuleIndex(idx); + checkRuleType(r); rules.set(idx, r); } - public void addRule(CFRuleRecord r) { + public void addRule(CFRuleBase r) { if (r == null) { throw new IllegalArgumentException("r must not be null"); } @@ -147,6 +172,7 @@ public final class CFRecordsAggregate extends RecordAggregate { + " any more than " + MAX_97_2003_CONDTIONAL_FORMAT_RULES + " - this file will cause problems with old Excel versions"); } + checkRuleType(r); rules.add(r); header.setNumberOfConditionalFormats(rules.size()); } @@ -160,25 +186,29 @@ public final class CFRecordsAggregate extends RecordAggregate { public String toString() { StringBuffer buffer = new StringBuffer(); + String type = "CF"; + if (header instanceof CFHeader12Record) { + type = "CF12"; + } - buffer.append("[CF]\n"); + buffer.append("[").append(type).append("]\n"); if( header != null ) { buffer.append(header.toString()); } for(int i=0; iHSSFSheet @@ -146,7 +147,7 @@ public final class HSSFSheetConditionalFormatting implements SheetConditionalFor throw new IllegalArgumentException("Number of rules must not exceed 3"); } - CFRuleRecord[] rules = new CFRuleRecord[cfRules.length]; + CFRuleBase[] rules = new CFRuleBase[cfRules.length]; for (int i = 0; i != cfRules.length; i++) { rules[i] = cfRules[i].getCfRuleRecord(); } diff --git a/src/testcases/org/apache/poi/hssf/record/aggregates/TestCFRecordsAggregate.java b/src/testcases/org/apache/poi/hssf/record/aggregates/TestCFRecordsAggregate.java index 89cca1e69b..c58f401bc4 100644 --- a/src/testcases/org/apache/poi/hssf/record/aggregates/TestCFRecordsAggregate.java +++ b/src/testcases/org/apache/poi/hssf/record/aggregates/TestCFRecordsAggregate.java @@ -28,6 +28,7 @@ import junit.framework.TestCase; import org.apache.poi.hssf.model.RecordStream; import org.apache.poi.hssf.record.CFHeaderBase; import org.apache.poi.hssf.record.CFHeaderRecord; +import org.apache.poi.hssf.record.CFRule12Record; import org.apache.poi.hssf.record.CFRuleBase; import org.apache.poi.hssf.record.CFRuleBase.ComparisonOperator; import org.apache.poi.hssf.record.CFRuleRecord; @@ -128,4 +129,30 @@ public final class TestCFRecordsAggregate extends TestCase { } assertEquals(rules.length, nRules); } + + public void testCantMixTypes() { + HSSFWorkbook workbook = new HSSFWorkbook(); + HSSFSheet sheet = workbook.createSheet(); + CellRangeAddress[] cellRanges = { + new CellRangeAddress(0,1,0,0), + new CellRangeAddress(0,1,2,2), + }; + CFRuleBase[] rules = { + CFRuleRecord.create(sheet, "7"), + CFRule12Record.create(sheet, ComparisonOperator.BETWEEN, "2", "5"), + }; + try { + new CFRecordsAggregate(cellRanges, rules); + fail("Shouldn't be able to mix between types"); + } catch (IllegalArgumentException e) {} + + + rules = new CFRuleBase[] { CFRuleRecord.create(sheet, "7") }; + CFRecordsAggregate agg = new CFRecordsAggregate(cellRanges, rules); + + try { + agg.addRule(CFRule12Record.create(sheet, "7")); + fail("Shouldn't be able to mix between types"); + } catch (IllegalArgumentException e) {} + } } -- 2.39.5