Top Description Inners Fields Constructors Methods
org.apache.poi.ss.formula

pack-priv final Class FormulaUsedBlankCellSet

extends Object
Class Inheritance
Imports
java.util.ArrayList, .HashMap, .List, .Map, org.apache.poi.ss.util.CellReference

Optimization - compacts many blank cell references used by a single formula.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class
public static class

Field Summary

Modifier and TypeField and Description
private final Map<FormulaUsedBlankCellSet.BookSheetKey, FormulaUsedBlankCellSet.BlankCellSheetGroup>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
addCell(EvaluationWorkbook evalWorkbook, int bookIndex, int sheetIndex, int rowIndex, int columnIndex)

public boolean
containsCell(FormulaUsedBlankCellSet.BookSheetKey key, int rowIndex, int columnIndex)

private FormulaUsedBlankCellSet.BlankCellSheetGroup
getSheetGroup(EvaluationWorkbook evalWorkbook, int bookIndex, int sheetIndex)

public boolean
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_sheetGroupsByBookSheetback to summary
private final Map<FormulaUsedBlankCellSet.BookSheetKey, FormulaUsedBlankCellSet.BlankCellSheetGroup> _sheetGroupsByBookSheet

Constructor Detail

FormulaUsedBlankCellSetback to summary
public FormulaUsedBlankCellSet()

Method Detail

addCellback to summary
public void addCell(EvaluationWorkbook evalWorkbook, int bookIndex, int sheetIndex, int rowIndex, int columnIndex)
containsCellback to summary
public boolean containsCell(FormulaUsedBlankCellSet.BookSheetKey key, int rowIndex, int columnIndex)
getSheetGroupback to summary
private FormulaUsedBlankCellSet.BlankCellSheetGroup getSheetGroup(EvaluationWorkbook evalWorkbook, int bookIndex, int sheetIndex)
isEmptyback to summary
public boolean isEmpty()
org.apache.poi.ss.formula back to summary

private final Class FormulaUsedBlankCellSet.BlankCellRectangleGroup

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.poi.ss.formula.FormulaUsedBlankCellSet.BlankCellRectangleGroup

Field Summary

Modifier and TypeField and Description
private final int
private final int
private final int
private int

Constructor Summary

AccessConstructor and Description
public
BlankCellRectangleGroup(int firstRowIndex, int firstColumnIndex, int lastColumnIndex)

Method Summary

Modifier and TypeMethod and Description
public boolean
acceptRow(int rowIndex, int firstColumnIndex, int lastColumnIndex)

public boolean
containsCell(int rowIndex, int columnIndex)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

_firstColumnIndexback to summary
private final int _firstColumnIndex
_firstRowIndexback to summary
private final int _firstRowIndex
_lastColumnIndexback to summary
private final int _lastColumnIndex
_lastRowIndexback to summary
private int _lastRowIndex

Constructor Detail

BlankCellRectangleGroupback to summary
public BlankCellRectangleGroup(int firstRowIndex, int firstColumnIndex, int lastColumnIndex)

Method Detail

acceptRowback to summary
public boolean acceptRow(int rowIndex, int firstColumnIndex, int lastColumnIndex)
containsCellback to summary
public boolean containsCell(int rowIndex, int columnIndex)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.apache.poi.ss.formula back to summary

private final Class FormulaUsedBlankCellSet.BlankCellSheetGroup

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.poi.ss.formula.FormulaUsedBlankCellSet.BlankCellSheetGroup

Field Summary

Modifier and TypeField and Description
private FormulaUsedBlankCellSet.BlankCellRectangleGroup
private int
private int
private int
private int
private final List<FormulaUsedBlankCellSet.BlankCellRectangleGroup>

Constructor Summary

AccessConstructor and Description
public
BlankCellSheetGroup(int lastDefinedRow)

Method Summary

Modifier and TypeMethod and Description
public void
addCell(int rowIndex, int columnIndex)

public boolean
containsCell(int rowIndex, int columnIndex)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_currentRectangleGroupback to summary
private FormulaUsedBlankCellSet.BlankCellRectangleGroup _currentRectangleGroup
_currentRowIndexback to summary
private int _currentRowIndex
_firstColumnIndexback to summary
private int _firstColumnIndex
_lastColumnIndexback to summary
private int _lastColumnIndex
_lastDefinedRowback to summary
private int _lastDefinedRow
_rectangleGroupsback to summary
private final List<FormulaUsedBlankCellSet.BlankCellRectangleGroup> _rectangleGroups

Constructor Detail

BlankCellSheetGroupback to summary
public BlankCellSheetGroup(int lastDefinedRow)

Method Detail

addCellback to summary
public void addCell(int rowIndex, int columnIndex)
containsCellback to summary
public boolean containsCell(int rowIndex, int columnIndex)
org.apache.poi.ss.formula back to summary

public final Class FormulaUsedBlankCellSet.BookSheetKey

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.poi.ss.formula.FormulaUsedBlankCellSet.BookSheetKey

Field Summary

Modifier and TypeField and Description
private final int
private final int

Constructor Summary

AccessConstructor and Description
public
BookSheetKey(int bookIndex, int sheetIndex)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

_bookIndexback to summary
private final int _bookIndex
_sheetIndexback to summary
private final int _sheetIndex

Constructor Detail

BookSheetKeyback to summary
public BookSheetKey(int bookIndex, int sheetIndex)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override