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

pack-priv final Class ForkedEvaluationSheet

extends Object
implements EvaluationSheet
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.EvaluationSheet
Annotations
@Internal
Imports
java.util.Arrays, .HashMap, .Map, org.apache.poi.ss.formula.EvaluationCell, .EvaluationSheet, .EvaluationWorkbook, org.apache.poi.ss.usermodel.Cell, .Row, .Sheet, org.apache.poi.ss.util.CellReference, org.apache.poi.util.Internal

Represents a sheet being used for forked evaluation. Initially, objects of this class contain only the cells from the master workbook. By calling getOrCreateUpdatableCell(int, int), the master cell object is logically replaced with a ForkedEvaluationCell instance, which will be used in all subsequent evaluations.
For POI internal use only

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private final EvaluationSheet
private final Map<ForkedEvaluationSheet.RowColKey, ForkedEvaluationCell>
_sharedCellsByRowCol

Only cells which have been split are put in this map.

Constructor Summary

AccessConstructor and Description
public

Method Summary

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

Implements org.apache.poi.ss.formula.EvaluationSheet.getCell.

public int
public ForkedEvaluationCell
getOrCreateUpdatableCell(int rowIndex, int columnIndex)

public int
public boolean
isRowHidden(int rowIndex)

Implements org.apache.poi.ss.formula.EvaluationSheet.isRowHidden.

Used by SUBTOTAL and similar functions that have options to ignore hidden rows

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_masterSheetback to summary
private final EvaluationSheet _masterSheet
_sharedCellsByRowColback to summary
private final Map<ForkedEvaluationSheet.RowColKey, ForkedEvaluationCell> _sharedCellsByRowCol

Only cells which have been split are put in this map. (This has been done to conserve memory).

Constructor Detail

ForkedEvaluationSheetback to summary
public ForkedEvaluationSheet(EvaluationSheet masterSheet)

Method Detail

clearAllCachedResultValuesback to summary
public void clearAllCachedResultValues()

Implements org.apache.poi.ss.formula.EvaluationSheet.clearAllCachedResultValues.

Doc from org.apache.poi.ss.formula.EvaluationSheet.clearAllCachedResultValues.

Propagated from EvaluationWorkbook#clearAllCachedResultValues() to clear locally cached data.

Annotations
@Override
copyUpdatedCellsback to summary
public void copyUpdatedCells(Sheet sheet)
getCellback to summary
public EvaluationCell getCell(int rowIndex, int columnIndex)

Implements org.apache.poi.ss.formula.EvaluationSheet.getCell.

Returns:EvaluationCell

Doc from org.apache.poi.ss.formula.EvaluationSheet.getCell.

null if there is no cell at the specified coordinates

Annotations
@Override
getLastRowNumback to summary
public int getLastRowNum()

Implements org.apache.poi.ss.formula.EvaluationSheet.getLastRowNum.

Returns:int

Doc from org.apache.poi.ss.formula.EvaluationSheet.getLastRowNum.

last row index referenced on this sheet, for evaluation optimization

Annotations
@Override
getOrCreateUpdatableCellback to summary
public ForkedEvaluationCell getOrCreateUpdatableCell(int rowIndex, int columnIndex)
getSheetIndexback to summary
public int getSheetIndex(EvaluationWorkbook mewb)
isRowHiddenback to summary
public boolean isRowHidden(int rowIndex)

Implements org.apache.poi.ss.formula.EvaluationSheet.isRowHidden.

Doc from org.apache.poi.ss.formula.EvaluationSheet.isRowHidden.

Used by SUBTOTAL and similar functions that have options to ignore hidden rows

Returns:boolean

true if the row is hidden, false if not

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

private final Class ForkedEvaluationSheet.RowColKey

extends Object
implements Comparable<ForkedEvaluationSheet.RowColKey>
Class Inheritance
  • java.lang.Object
  • org.apache.poi.ss.formula.eval.forked.ForkedEvaluationSheet.RowColKey
All Implemented Interfaces
java.lang.Comparable

Field Summary

Modifier and TypeField and Description
private final int
private final int

Constructor Summary

AccessConstructor and Description
public
RowColKey(int rowIndex, int columnIndex)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(ForkedEvaluationSheet.RowColKey
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

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
public int
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

_columnIndexback to summary
private final int _columnIndex
_rowIndexback to summary
private final int _rowIndex

Constructor Detail

RowColKeyback to summary
public RowColKey(int rowIndex, int columnIndex)

Method Detail

compareToback to summary
public int compareTo(ForkedEvaluationSheet.RowColKey o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:ForkedEvaluationSheet.RowColKey

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
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
getColumnIndexback to summary
public int getColumnIndex()
getRowIndexback to summary
public int getRowIndex()
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