/* ==================================================================== 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.formula.ptg; import java.util.Map; import java.util.function.Supplier; import org.apache.poi.ss.SpreadsheetVersion; import org.apache.poi.ss.util.AreaReference; import org.apache.poi.ss.util.CellReference; import org.apache.poi.util.BitField; import org.apache.poi.util.BitFieldFactory; import org.apache.poi.util.GenericRecordUtil; import org.apache.poi.util.LittleEndianInput; import org.apache.poi.util.LittleEndianOutput; /** * Specifies a rectangular area of cells A1:A4 for instance. */ public abstract class AreaPtgBase extends OperandPtg implements AreaI { private static final BitField rowRelative = BitFieldFactory.getInstance(0x8000); private static final BitField colRelative = BitFieldFactory.getInstance(0x4000); private static final BitField columnMask = BitFieldFactory.getInstance(0x3FFF); /** zero based, unsigned 16 bit */ private int field_1_first_row; /** zero based, unsigned 16 bit */ private int field_2_last_row; /** zero based, unsigned 8 bit */ private int field_3_first_column; //BitFields: (first row relative, first col relative, first column number) /** zero based, unsigned 8 bit */ private int field_4_last_column; //BitFields: (last row relative, last col relative, last column number) protected AreaPtgBase() {} protected AreaPtgBase(AreaPtgBase other) { super(other); field_1_first_row = other.field_1_first_row; field_2_last_row = other.field_2_last_row; field_3_first_column = other.field_3_first_column; field_4_last_column = other.field_4_last_column; } protected AreaPtgBase(AreaReference ar) { CellReference firstCell = ar.getFirstCell(); CellReference lastCell = ar.getLastCell(); setFirstRow(firstCell.getRow()); setFirstColumn(firstCell.getCol() == -1 ? 0 : firstCell.getCol()); setLastRow(lastCell.getRow()); setLastColumn(lastCell.getCol() == -1 ? 0xFF : lastCell.getCol()); setFirstColRelative(!firstCell.isColAbsolute()); setLastColRelative(!lastCell.isColAbsolute()); setFirstRowRelative(!firstCell.isRowAbsolute()); setLastRowRelative(!lastCell.isRowAbsolute()); } protected AreaPtgBase(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative) { if (lastRow >= firstRow) { setFirstRow(firstRow); setLastRow(lastRow); setFirstRowRelative(firstRowRelative); setLastRowRelative(lastRowRelative); } else { setFirstRow(lastRow); setLastRow(firstRow); setFirstRowRelative(lastRowRelative); setLastRowRelative(firstRowRelative); } if (lastColumn >= firstColumn) { setFirstColumn(firstColumn); setLastColumn(lastColumn); setFirstColRelative(firstColRelative); setLastColRelative(lastColRelative); } else { setFirstColumn(lastColumn); setLastColumn(firstColumn); setFirstColRelative(lastColRelative); setLastColRelative(firstColRelative); } } /** * Sort the first and last row and columns in-place to the preferred (top left:bottom right) order * Note: Sort only occurs when an instance is constructed or when this method is called. * *
For example, $E5:B$10
becomes B5:$E$10
true
if the last row relative, else
* false
*/
public final void setLastRowRelative(boolean rel) {
field_4_last_column=rowRelative.setBoolean(field_4_last_column,rel);
}
/**
* @return lastcol relative or not
*/
public final boolean isLastColRelative() {
return colRelative.isSet(field_4_last_column);
}
/**
* set whether the last column should be relative or not
*/
public final void setLastColRelative(boolean rel) {
field_4_last_column=colRelative.setBoolean(field_4_last_column,rel);
}
/**
* set the last column in the area
*/
public final void setLastColumn(int colIx) {
field_4_last_column=columnMask.setValue(field_4_last_column, colIx);
}
/**
* set the last column irrespective of the bitmasks
*/
public final void setLastColumnRaw(short column) {
field_4_last_column = column;
}
protected final String formatReferenceAsString() {
CellReference topLeft = new CellReference(getFirstRow(),getFirstColumn(),!isFirstRowRelative(),!isFirstColRelative());
CellReference botRight = new CellReference(getLastRow(),getLastColumn(),!isLastRowRelative(),!isLastColRelative());
if(AreaReference.isWholeColumnReference(SpreadsheetVersion.EXCEL97, topLeft, botRight)) {
return (new AreaReference(topLeft, botRight, SpreadsheetVersion.EXCEL97)).formatAsString();
}
return topLeft.formatAsString() + ":" + botRight.formatAsString();
}
public String toFormulaString() {
return formatReferenceAsString();
}
public byte getDefaultOperandClass() {
return Ptg.CLASS_REF;
}
@Override
public Map