moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

#59170 - Remove deprecated classes (POI 3.15) - org.apache.poi.hssf/ss.util.Region

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1734651 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Andreas Beeker 2016-03-12 00:17:16 +00:00
parent 0776e32108
commit 7d6be0ff54
8 changed files with 0 additions and 463 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/java/org/apache/poi/hssf/usermodel/HSSFConditionalFormatting.java
View File

@ -91,13 +91,6 @@ public final class HSSFConditionalFormatting implements ConditionalFormatting {
return cfAggregate; return cfAggregate;
} }
/**
* @deprecated (Aug-2008) use {@link HSSFConditionalFormatting#getFormattingRanges()}
*/
public org.apache.poi.ss.util.Region[] getFormattingRegions() {
CellRangeAddress[] cellRanges = getFormattingRanges();
return org.apache.poi.ss.util.Region.convertCellRangesToRegions(cellRanges);
}
/** /**
* @return array of <tt>CellRangeAddress</tt>s. never <code>null</code> * @return array of <tt>CellRangeAddress</tt>s. never <code>null</code>
*/ */

12
src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
View File

@ -115,18 +115,6 @@ public class HSSFFormulaEvaluator implements FormulaEvaluator, WorkbookEvaluator
return _bookEvaluator; return _bookEvaluator;
} }
/**
* Does nothing
* @deprecated (Aug 2008) - not needed, since the current row can be derived from the cell
*/
@Deprecated
public void setCurrentRow(HSSFRow row) {
// do nothing
// if (false) {
// row.getClass(); // suppress unused parameter compiler warning
// }
}
/** /**
* Should be called whenever there are major changes (e.g. moving sheets) to input cells * Should be called whenever there are major changes (e.g. moving sheets) to input cells
* in the evaluated workbook. If performance is not critical, a single call to this method * in the evaluated workbook. If performance is not critical, a single call to this method

6
src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java
View File

@ -162,12 +162,6 @@ public final class HSSFSheetConditionalFormatting implements SheetConditionalFor
return addConditionalFormatting((HSSFConditionalFormatting)cf); return addConditionalFormatting((HSSFConditionalFormatting)cf);
} }
/**
* @deprecated use <tt>CellRangeAddress</tt> instead of <tt>Region</tt>
*/
public int addConditionalFormatting(org.apache.poi.ss.util.Region[] regions, HSSFConditionalFormattingRule[] cfRules) {
return addConditionalFormatting(org.apache.poi.ss.util.Region.convertRegionsToCellRanges(regions), cfRules);
}
/** /**
* Allows to add a new Conditional Formatting set to the sheet. * Allows to add a new Conditional Formatting set to the sheet.
* *

63
src/java/org/apache/poi/hssf/util/HSSFRegionUtil.java
View File

@ -31,20 +31,6 @@ public final class HSSFRegionUtil {
// no instances of this class // no instances of this class
} }
/**
* @deprecated (Aug 2008) use {@link CellRangeAddress} instead of {@link Region}
*/
private static CellRangeAddress toCRA(org.apache.poi.ss.util.Region region) {
return org.apache.poi.ss.util.Region.convertToCellRangeAddress(region);
}
/**
* @deprecated (Aug 2008) use {@link CellRangeAddress} instead of {@link Region}
*/
public static void setBorderLeft(short border, Region region, HSSFSheet sheet,
HSSFWorkbook workbook) {
setBorderLeft(border, toCRA(region), sheet, workbook);
}
/** /**
* Sets the left border for a region of cells by manipulating the cell style * Sets the left border for a region of cells by manipulating the cell style
* of the individual cells on the left * of the individual cells on the left
@ -59,13 +45,6 @@ public final class HSSFRegionUtil {
RegionUtil.setBorderLeft(border, region, sheet, workbook); RegionUtil.setBorderLeft(border, region, sheet, workbook);
} }
/**
* @deprecated (Aug 2008) use {@link CellRangeAddress} instead of {@link Region}
*/
public static void setLeftBorderColor(short color, Region region, HSSFSheet sheet,
HSSFWorkbook workbook) {
setLeftBorderColor(color, toCRA(region), sheet, workbook);
}
/** /**
* Sets the leftBorderColor attribute of the HSSFRegionUtil object * Sets the leftBorderColor attribute of the HSSFRegionUtil object
* *
@ -79,13 +58,6 @@ public final class HSSFRegionUtil {
RegionUtil.setLeftBorderColor(color, region, sheet, workbook); RegionUtil.setLeftBorderColor(color, region, sheet, workbook);
} }
/**
* @deprecated (Aug 2008) use {@link CellRangeAddress} instead of {@link Region}
*/
public static void setBorderRight(short border, Region region, HSSFSheet sheet,
HSSFWorkbook workbook) {
setBorderRight(border, toCRA(region), sheet, workbook);
}
/** /**
* Sets the borderRight attribute of the HSSFRegionUtil object * Sets the borderRight attribute of the HSSFRegionUtil object
* *
@ -99,13 +71,6 @@ public final class HSSFRegionUtil {
RegionUtil.setBorderRight(border, region, sheet, workbook); RegionUtil.setBorderRight(border, region, sheet, workbook);
} }
/**
* @deprecated (Aug 2008) use {@link CellRangeAddress} instead of {@link Region}
*/
public static void setRightBorderColor(short color, Region region, HSSFSheet sheet,
HSSFWorkbook workbook) {
setRightBorderColor(color, toCRA(region), sheet, workbook);
}
/** /**
* Sets the rightBorderColor attribute of the HSSFRegionUtil object * Sets the rightBorderColor attribute of the HSSFRegionUtil object
* *
@ -119,13 +84,6 @@ public final class HSSFRegionUtil {
RegionUtil.setRightBorderColor(color, region, sheet, workbook); RegionUtil.setRightBorderColor(color, region, sheet, workbook);
} }
/**
* @deprecated (Aug 2008) use {@link CellRangeAddress} instead of {@link Region}
*/
public static void setBorderBottom(short border, Region region, HSSFSheet sheet,
HSSFWorkbook workbook) {
setBorderBottom(border, toCRA(region), sheet, workbook);
}
/** /**
* Sets the borderBottom attribute of the HSSFRegionUtil object * Sets the borderBottom attribute of the HSSFRegionUtil object
* *
@ -139,13 +97,6 @@ public final class HSSFRegionUtil {
RegionUtil.setBorderBottom(border, region, sheet, workbook); RegionUtil.setBorderBottom(border, region, sheet, workbook);
} }
/**
* @deprecated (Aug 2008) use {@link CellRangeAddress} instead of {@link Region}
*/
public static void setBottomBorderColor(short color, Region region, HSSFSheet sheet,
HSSFWorkbook workbook) {
setBottomBorderColor(color, toCRA(region), sheet, workbook);
}
/** /**
* Sets the bottomBorderColor attribute of the HSSFRegionUtil object * Sets the bottomBorderColor attribute of the HSSFRegionUtil object
* *
@ -159,13 +110,6 @@ public final class HSSFRegionUtil {
RegionUtil.setBottomBorderColor(color, region, sheet, workbook); RegionUtil.setBottomBorderColor(color, region, sheet, workbook);
} }
/**
* @deprecated (Aug 2008) use {@link CellRangeAddress} instead of {@link Region}
*/
public static void setBorderTop(short border, Region region, HSSFSheet sheet,
HSSFWorkbook workbook) {
setBorderTop(border, toCRA(region), sheet, workbook);
}
/** /**
* Sets the borderBottom attribute of the HSSFRegionUtil object * Sets the borderBottom attribute of the HSSFRegionUtil object
* *
@ -179,13 +123,6 @@ public final class HSSFRegionUtil {
RegionUtil.setBorderTop(border, region, sheet, workbook); RegionUtil.setBorderTop(border, region, sheet, workbook);
} }
/**
* @deprecated (Aug 2008) use {@link CellRangeAddress} instead of {@link Region}
*/
public static void setTopBorderColor(short color, Region region, HSSFSheet sheet,
HSSFWorkbook workbook) {
setTopBorderColor(color, toCRA(region), sheet, workbook);
}
/** /**
* Sets the topBorderColor attribute of the HSSFRegionUtil object * Sets the topBorderColor attribute of the HSSFRegionUtil object
* *

47
src/java/org/apache/poi/hssf/util/Region.java
View File

@ -1,47 +0,0 @@
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.hssf.util;
/**
* Represents a from/to row/col square. This is a object primitive
* that can be used to represent row,col - row,col just as one would use String
* to represent a string of characters. Its really only useful for HSSF though.
*
* @deprecated (Aug-2008) use {@link org.apache.poi.ss.util.CellRangeAddress}
*/
public class Region extends org.apache.poi.ss.util.Region
{
/**
* Creates a new instance of Region (0,0 - 0,0)
*/
public Region()
{
super();
}
public Region(int rowFrom, short colFrom, int rowTo, short colTo)
{
super(rowFrom, colFrom, rowTo, colTo);
}
public Region(String ref) {
super(ref);
}
}

272
src/java/org/apache/poi/ss/util/Region.java
View File

@ -1,272 +0,0 @@
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.ss.util;
/**
* Represents a from/to row/col square. This is a object primitive
* that can be used to represent row,col - row,col just as one would use String
* to represent a string of characters. Its really only useful for HSSF though.
*
* @author Andrew C. Oliver acoliver at apache dot org
* @deprecated (Aug-2008) use {@link CellRangeAddress}
*/
public class Region implements Comparable<Region> {
private int _rowFrom;
private short _colFrom;
private int _rowTo;
private short _colTo;
/**
* Creates a new instance of Region (0,0 - 0,0)
*/
public Region()
{
}
public Region(int rowFrom, short colFrom, int rowTo, short colTo)
{
this._rowFrom = rowFrom;
this._rowTo = rowTo;
this._colFrom = colFrom;
this._colTo = colTo;
}
public Region(String ref) {
CellReference cellReferenceFrom = new CellReference(ref.substring(0, ref.indexOf(":")));
CellReference cellReferenceTo = new CellReference(ref.substring(ref.indexOf(":") + 1));
this._rowFrom = cellReferenceFrom.getRow();
this._colFrom = cellReferenceFrom.getCol();
this._rowTo = cellReferenceTo.getRow();
this._colTo = cellReferenceTo.getCol();
}
/**
* get the upper left hand corner column number
*
* @return column number for the upper left hand corner
*/
public short getColumnFrom()
{
return _colFrom;
}
/**
* get the upper left hand corner row number
*
* @return row number for the upper left hand corner
*/
public int getRowFrom()
{
return _rowFrom;
}
/**
* get the lower right hand corner column number
*
* @return column number for the lower right hand corner
*/
public short getColumnTo()
{
return _colTo;
}
/**
* get the lower right hand corner row number
*
* @return row number for the lower right hand corner
*/
public int getRowTo()
{
return _rowTo;
}
/**
* set the upper left hand corner column number
*
* @param colFrom column number for the upper left hand corner
*/
public void setColumnFrom(short colFrom)
{
this._colFrom = colFrom;
}
/**
* set the upper left hand corner row number
*
* @param rowFrom row number for the upper left hand corner
*/
public void setRowFrom(int rowFrom)
{
this._rowFrom = rowFrom;
}
/**
* set the lower right hand corner column number
*
* @param colTo column number for the lower right hand corner
*/
public void setColumnTo(short colTo)
{
this._colTo = colTo;
}
/**
* get the lower right hand corner row number
*
* @param rowTo row number for the lower right hand corner
*/
public void setRowTo(int rowTo)
{
this._rowTo = rowTo;
}
/**
* Answers: "is the row/column inside this range?"
*
* @return <code>true</code> if the cell is in the range and
* <code>false</code> if it is not
*/
public boolean contains(int row, short col)
{
if ((this._rowFrom <= row) && (this._rowTo >= row)
&& (this._colFrom <= col) && (this._colTo >= col))
{
// System.out.println("Region ("+rowFrom+","+colFrom+","+rowTo+","+
// colTo+") does contain "+row+","+col);
return true;
}
return false;
}
@Override
public boolean equals(Object o) {
if (this instanceof Region)
return equals((Region) o);
else
return false;
}
public boolean equals(Region r)
{
return (compareTo(r) == 0);
}
@Override
public int hashCode() {
assert false : "hashCode not designed";
return 42; // any arbitrary constant will do
}
/**
* Compares that the given region is the same less than or greater than this
* region. If any regional coordiant passed in is less than this regions
* coordinants then a positive integer is returned. Otherwise a negative
* integer is returned.
*
* @param r region
* @see #compareTo(Object)
*/
public int compareTo(Region r)
{
if ((this.getRowFrom() == r.getRowFrom())
&& (this.getColumnFrom() == r.getColumnFrom())
&& (this.getRowTo() == r.getRowTo())
&& (this.getColumnTo() == r.getColumnTo()))
{
return 0;
}
if ((this.getRowFrom() < r.getRowFrom())
|| (this.getColumnFrom() < r.getColumnFrom())
|| (this.getRowTo() < r.getRowTo())
|| (this.getColumnTo() < r.getColumnTo()))
{
return 1;
}
return -1;
}
/**
* @return the size of the region (number of cells in the area).
*/
public int getArea() {
return (_rowTo - _rowFrom + 1) * (_colTo - _colFrom + 1);
}
/**
* Convert a List of CellRange objects to an array of regions
*
* @param cellRanges list of CellRange objects
* @return regions
*/
public static Region[] convertCellRangesToRegions(CellRangeAddress[] cellRanges) {
int size = cellRanges.length;
if(size < 1) {
return new Region[0];
}
Region[] result = new Region[size];
for (int i = 0; i != size; i++) {
result[i] = convertToRegion(cellRanges[i]);
}
return result;
}
private static Region convertToRegion(CellRangeAddress cr) {
return new Region(cr.getFirstRow(), (short)cr.getFirstColumn(), cr.getLastRow(), (short)cr.getLastColumn());
}
public static CellRangeAddress[] convertRegionsToCellRanges(Region[] regions) {
int size = regions.length;
if(size < 1) {
return new CellRangeAddress[0];
}
CellRangeAddress[] result = new CellRangeAddress[size];
for (int i = 0; i != size; i++) {
result[i] = convertToCellRangeAddress(regions[i]);
}
return result;
}
public static CellRangeAddress convertToCellRangeAddress(Region r) {
return new CellRangeAddress(r.getRowFrom(), r.getRowTo(), r.getColumnFrom(), r.getColumnTo());
}
/**
* @return the string reference for this region
*/
public String getRegionRef() {
CellReference cellRefFrom = new CellReference(_rowFrom, _colFrom);
CellReference cellRefTo = new CellReference(_rowTo, _colTo);
String ref = cellRefFrom.formatAsString() + ":" + cellRefTo.formatAsString();
return ref;
}
}

1
src/testcases/org/apache/poi/ss/util/AllSSUtilTests.java
View File

@ -33,7 +33,6 @@ import org.junit.runners.Suite;
TestExpandedDouble.class, TestExpandedDouble.class,
TestNumberComparer.class, TestNumberComparer.class,
TestNumberToTextConverter.class, TestNumberToTextConverter.class,
TestRegion.class,
TestSheetBuilder.class, TestSheetBuilder.class,
TestSheetUtil.class, TestSheetUtil.class,
TestWorkbookUtil.class TestWorkbookUtil.class

55
src/testcases/org/apache/poi/ss/util/TestRegion.java
View File

@ -1,55 +0,0 @@
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.ss.util;
import junit.framework.TestCase;
/**
* Tests that the common CellReference works as we need it to
*/
@SuppressWarnings("deprecation") // the Region class is deprecated in the public API, but still needs to be tested
public final class TestRegion extends TestCase {
public void testGetRegionRef() {
int rowFrom = 3;
short colFrom = 3;
int rowTo = 9;
short colTo = 9;
Region region = new Region(rowFrom, colFrom, rowTo, colTo);
assertEquals("D4:J10", region.getRegionRef());
}
public void testContains() {
int rowFrom = 3;
short colFrom = 3;
int rowTo = 9;
short colTo = 9;
Region region = new Region(rowFrom, colFrom, rowTo, colTo);
assertEquals("D4:J10", region.getRegionRef());
assertTrue(region.contains(5, (short) 7));
assertTrue(region.contains(9, (short) 9));
assertFalse(region.contains(9, (short) 10));
}
public void testConstructors() {
Region region_1 = new Region("A1:E7");
assertEquals(0, region_1.getColumnFrom());
assertEquals((short)4, region_1.getColumnTo());
}
}