LookupReferenceCalculator (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.formulas.LookupReferenceCalculator

```
public class LookupReferenceCalculator
extends Object
```
LookupReferenceCalculator is a collection of static methods that operate as the Microsoft Excel function calls do. All methods are called with an array of ptg's, which are then acted upon. A Ptg of the type that makes sense (ie boolean, number) is returned after each method.

Constructor Summary

Constructors
Constructor and Description

LookupReferenceCalculator()

Constructors
Constructor and Description
`LookupReferenceCalculator()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`protected static Ptg`	`calcAddress(Ptg[] operands)` ADDRESS Creates a cell address as text, given specified row and column numbers.
`protected static Ptg`	`calcAreas(Ptg[] operands)` AREAS Returns the number of areas in a reference.
`protected static Ptg`	`calcChoose(Ptg[] operands)` CHOOSE Chooses a value from a list of values Note, this function does not support one specific use-case.
`protected static Ptg`	`calcColumn(Ptg[] operands)` COLUMN Returns the column number of a reference
`protected static Ptg`	`calcColumns(Ptg[] operands)` COLUMNS Returns the number of columns in an array reference or array formula
`protected static Ptg`	`calcHlookup(Ptg[] operands)` HLOOKUP: Looks in the top row of an array and returns the value of the indicated cell.
`protected static Ptg`	`calcHyperlink(Ptg[] operands)` HYPERLINK Creates a shortcut or jump that opens a document stored on a network server, an intranet, or the Internet Function just returns the "friendly name" of the link, Excel doesn't appear to validate the url ...
`protected static Ptg`	`calcIndex(Ptg[] operands)` INDEX Returns a value or the reference to a value from within a table or range.
`protected static Ptg`	`calcIndirect(Ptg[] operands)` INDIRECT Returns a reference indicated by a text value INDIRECT(ref_text,a1) Ref_text is a reference to a cell that contains an A1-style reference, an R1C1-style reference, a name defined as a reference, or a reference to a cell as a text string.
`static Ptg`	`calcLookup(Ptg[] operands)` LOOKUP The LOOKUP function returns a value either from a one-row or one-column range You can also use the LOOKUP function as an alternative to the IF function for elaborate tests or tests that exceed the limit for nesting of functions.
`static Ptg`	`calcMatch(Ptg[] operands)` MATCH Looks up values in a reference or array Returns the relative position of an item in an array that matches a specified value in a specified order.
`protected static Ptg`	`calcOffset(Ptg[] operands)` calcOffset Returns a reference to a range that is a specified number of rows and columns from a cell or range of cells.
`protected static Ptg`	`calcRow(Ptg[] operands)` ROW Returns the row number of a reference Note this is 1 based, ie Row1 = 1.
`protected static Ptg`	`calcRows(Ptg[] operands)` ROWS Returns the number of rows in a reference ROWS(array) Array is an array, an array formula, or a reference to a range of cells for which you want the number of rows.
`protected static Ptg`	`calcTranspose(Ptg[] operands)` TRANSPOSE Returns the transpose of an array The TRANSPOSE function returns a vertical range of cells as a horizontal range, or vice versa.
`protected static Ptg`	`calcVlookup(Ptg[] operands)` VLOOKUP Looks in the first column of an array and moves across the row to return the value of a cell Searches for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify in the table.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LookupReferenceCalculator
```
public LookupReferenceCalculator()
```
- Method Detail
  - calcAddress
```
protected static Ptg calcAddress(Ptg[] operands)
```
    ADDRESS Creates a cell address as text, given specified row and column numbers. Syntax ADDRESS(row_num,column_num,abs_num,a1,sheet_text) Row_num is the row number to use in the cell reference. Column_num is the column number to use in the cell reference. Abs_num specifies the type of reference to return. Abs_num Returns this type of reference 1 or omitted Absolute 2 Absolute row; relative column 3 Relative row; absolute column 4 Relative A1 is a logical value that specifies the A1 or R1C1 reference style. If a1 is TRUE or omitted, ADDRESS returns an A1-style reference; if FALSE, ADDRESS returns an R1C1-style reference. Sheet_text is text specifying the name of the worksheet to be used as the external reference. If sheet_text is omitted, no sheet name is used. Examples ADDRESS(2,3) equals "$C$2" ADDRESS(2,3,2) equals "C$2" ADDRESS(2,3,2,FALSE) equals "R2C[3]" ADDRESS(2,3,1,FALSE,"[Book1]Sheet1") equals "[Book1]Sheet1!R2C3" ADDRESS(2,3,1,FALSE,"EXCEL SHEET") equals "'EXCEL SHEET'!R2C3"
  - calcAreas
```
protected static Ptg calcAreas(Ptg[] operands)
```
    AREAS Returns the number of areas in a reference. An area is a range of contiguous cells or a single cell. Reference is a reference to a cell or range of cells and can refer to multiple areas. If you want to specify several references as a single argument, then you must include extra sets of parentheses so that Microsoft Excel will not interpret the comma as a field separator. NOTE: this appears to be correct given Excel information but logic is not 100% known e.g. =AREAS(B2:D4 D3) = 1 =AREAS(B2:D4 E3) gives a #NULL! error - why? =AREAS(B2:D4,E3) = 2
  - calcChoose
```
protected static Ptg calcChoose(Ptg[] operands)
```
    CHOOSE Chooses a value from a list of values Note, this function does not support one specific use-case. That is choosing a ptgref and using that ptgref to complete a ptgarea. Example =SUM(E6:CHOOSE(3,G4,G5,G6)) =SUM(E6:G6)
  - calcColumn
```
protected static Ptg calcColumn(Ptg[] operands)
```
    COLUMN Returns the column number of a reference
  - calcColumns
```
protected static Ptg calcColumns(Ptg[] operands)
```
    COLUMNS Returns the number of columns in an array reference or array formula
  - calcHlookup
```
protected static Ptg calcHlookup(Ptg[] operands)
                          throws FunctionNotSupportedException
```
    HLOOKUP: Looks in the top row of an array and returns the value of the indicated cell.
    
    Throws:
    
    FunctionNotSupportedException
  - calcHyperlink
```
protected static Ptg calcHyperlink(Ptg[] operands)
```
    HYPERLINK Creates a shortcut or jump that opens a document stored on a network server, an intranet, or the Internet Function just returns the "friendly name" of the link, Excel doesn't appear to validate the url ...
  - calcIndex
```
protected static Ptg calcIndex(Ptg[] operands)
```
    INDEX Returns a value or the reference to a value from within a table or range. There are two forms of the INDEX function: the array form and the reference form. Array Form: Returns the value of an element in a table or an array selected by the row and column number indexes. Use the array form if the first argument to INDEX is an array constant. INDEX(array,row_num,column_num) Array is a range of cells or an array constant. If array contains only one row or column, the corresponding row_num or column_num argument is optional. If array has more than one row and more than one column, and only row_num or column_num is used, INDEX returns an array of the entire row or column in array. Row_num selects the row in array from which to return a value. If row_num is omitted, column_num is required. Column_num selects the column in array from which to return a value. If column_num is omitted, row_num is required. Reference Form: Returns the reference of the cell at the intersection of a particular row and column. If the reference is made up of nonadjacent selections, you can pick the selection to look in. INDEX(reference,row_num,column_num,area_num) Reference is a reference to one or more cell ranges. If you are entering a nonadjacent range for the reference, enclose reference in parentheses. If each area in reference contains only one row or column, the row_num or column_num argument, respectively, is optional. For example, for a single row reference, use INDEX(reference,,column_num). Row_num is the number of the row in reference from which to return a reference. Column_num is the number of the column in reference from which to return a reference. Area_num selects a range in reference from which to return the intersection of row_num and column_num. The first area selected or entered is numbered 1, the second is 2, and so on. If area_num is omitted, INDEX uses area 1. Given a BiffRec Range, choose the cell within referenced by the row and column operands. example: =INDEX(G3:L8,6,4) returns the value of the BiffRec at row 6, col 4 in the following table which is 0.11 G H I J K L 1 2 3 0.007 0.005 0.003 0.002 0.002 0.001 4 0.025 0.017 0.012 0.008 0.006 0.005 5 0.062 0.044 0.032 0.023 0.018 0.015 6 0.116 0.086 0.064 0.049 0.04 0.035 7 0.171 0.13 0.101 0.082 0.07 0.062 8 0.211 0.165 0.132 0.11 0.096 0.088
  - calcIndirect
```
protected static Ptg calcIndirect(Ptg[] operands)
```
    INDIRECT Returns a reference indicated by a text value INDIRECT(ref_text,a1) Ref_text is a reference to a cell that contains an A1-style reference, an R1C1-style reference, a name defined as a reference, or a reference to a cell as a text string. If ref_text is not a valid cell reference, INDIRECT returns the #REF! error value. If ref_text refers to another workbook (an external reference), the other workbook must be open. If the source workbook is not open, INDIRECT returns the #REF! error value. A1 is a logical value that specifies what type of reference is contained in the cell ref_text. If a1 is TRUE or omitted, ref_text is interpreted as an A1-style reference. If a1 is FALSE, ref_text is interpreted as an R1C1-style reference.
  - calcLookup
```
public static Ptg calcLookup(Ptg[] operands)
```
    LOOKUP The LOOKUP function returns a value either from a one-row or one-column range You can also use the LOOKUP function as an alternative to the IF function for elaborate tests or tests that exceed the limit for nesting of functions. See the examples in the array form. For the LOOKUP function to work correctly, the data being looked up must be sorted in ascending order. If this is not possible, consider using the VLOOKUP, HLOOKUP, or MATCH functions. A vector is a range of only one row or one column. The vector form of LOOKUP looks in a one-row or one-column range (known as a vector) for a value and returns a value from the same position in a second one-row or one-column range. Use this form of the LOOKUP function when you want to specify the range that contains the values that you want to match. The other form of LOOKUP automatically looks in the first column or row.
  - calcMatch
```
public static Ptg calcMatch(Ptg[] operands)
```
    MATCH Looks up values in a reference or array Returns the relative position of an item in an array that matches a specified value in a specified order. Use MATCH instead of one of the LOOKUP functions when you need the position of an item in a range instead of the item itself. MATCH(lookup_value,lookup_array,match_type) Lookup_value is the value you want to match in lookup_array. For example, when you look up someone's number in a telephone book, you are using the person's name as the lookup value, but the telephone number is the value you want. Lookup_value can be a value (number, text, or logical value) or a cell reference to a number, text, or logical value. Lookup_array is a contiguous range of cells containing possible lookup values. Lookup_array must be an array or an array reference. Match_type is the number -1, 0, or 1. Match_type specifies how Microsoft Excel matches lookup_value with values in lookup_array. If match_type is 1, MATCH finds the largest value that is less than or equal to lookup_value. Lookup_array must be placed in ascending order: ...-2, -1, 0, 1, 2, ..., A-Z, FALSE, TRUE. If match_type is 0, MATCH finds the first value that is exactly equal to lookup_value. Lookup_array can be in any order. If match_type is -1, MATCH finds the smallest value that is greater than or equal to lookup_value. Lookup_array must be placed in descending order: TRUE, FALSE, Z-A, ...2, 1, 0, -1, -2, ..., and so on. If match_type is omitted, it is assumed to be 1. MATCH returns the position of the matched value within lookup_array, not the value itself. For example, MATCH("b",{"a","b","c"},0) returns 2, the relative position of "b" within the array {"a","b","c"}. MATCH does not distinguish between uppercase and lowercase letters when matching text values. If MATCH is unsuccessful in finding a match, it returns the #N/A error value. If match_type is 0 and lookup_value is text, lookup_value can contain the wildcard characters asterisk (*) and question mark (?). An asterisk matches any sequence of characters; a question mark matches any single character.
  - calcOffset
```
protected static Ptg calcOffset(Ptg[] operands)
```
    calcOffset Returns a reference to a range that is a specified number of rows and columns from a cell or range of cells. The reference that is returned can be a single cell or a range of cells. You can specify the number of rows and the number of columns to be returned. OFFSET(reference,rows,cols,height,width) Reference is the reference from which you want to base the offset. Reference must refer to a cell or range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value. Rows is the number of rows, up or down, that you want the upper-left cell to refer to. Using 5 as the rows argument specifies that the upper-left cell in the reference is five rows below reference. Rows can be positive (which means below the starting reference) or negative (which means above the starting reference). Cols is the number of columns, to the left or right, that you want the upper-left cell of the result to refer to. Using 5 as the cols argument specifies that the upper-left cell in the reference is five columns to the right of reference. Cols can be positive (which means to the right of the starting reference) or negative (which means to the left of the starting reference). Height is the height, in number of rows, that you want the returned reference to be. Height must be a positive number. Width is the width, in number of columns, that you want the returned reference to be. Width must be a positive number.
  - calcTranspose
```
protected static Ptg calcTranspose(Ptg[] operands)
```
    TRANSPOSE Returns the transpose of an array The TRANSPOSE function returns a vertical range of cells as a horizontal range, or vice versa. The TRANSPOSE function must be entered as an array formula has columns and rows. Use TRANSPOSE to shift the vertical and horizontal orientation of an array or range on a worksheet. array Required. An array or range of cells on a worksheet that you want to transpose. The transpose of an array is created by using the first row of the array as the first column of the new array, the second row of the array as the second column of the new array, and so on.
  - calcRow
```
protected static Ptg calcRow(Ptg[] operands)
                      throws FunctionNotSupportedException
```
    ROW Returns the row number of a reference Note this is 1 based, ie Row1 = 1.
    
    Throws:
    
    FunctionNotSupportedException
  - calcRows
```
protected static Ptg calcRows(Ptg[] operands)
                       throws FunctionNotSupportedException
```
    ROWS Returns the number of rows in a reference ROWS(array) Array is an array, an array formula, or a reference to a range of cells for which you want the number of rows. =ROWS(C1:E4) Number of rows in the reference (4) =ROWS({1,2,3;4,5,6}) Number of rows in the array constant (2)
    
    Throws:
    
    FunctionNotSupportedException
  - calcVlookup
```
protected static Ptg calcVlookup(Ptg[] operands)
                          throws FunctionNotSupportedException
```
    VLOOKUP Looks in the first column of an array and moves across the row to return the value of a cell Searches for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify in the table. Use VLOOKUP instead of HLOOKUP when your comparison values are located in a column to the left of the data you want to find. Syntax VLOOKUP(lookup_value,table_array,col_index_num,range_lookup) Lookup_value is the value to be found in the first column of the array. Lookup_value can be a value, a reference, or a text string. Table_array is the table of information in which data is looked up. Use a reference to a range or a range name, such as Database or List. If range_lookup is TRUE, the values in the first column of table_array must be placed in ascending order: ..., -2, -1, 0, 1, 2, ..., A-Z, FALSE, TRUE; otherwise VLOOKUP may not give the correct value. If range_lookup is FALSE, table_array does not need to be sorted. You can put the values in ascending order by choosing the Sort command from the Data menu and selecting Ascending. The values in the first column of table_array can be text, numbers, or logical values. Uppercase and lowercase text are equivalent. Col_index_num is the column number in table_array from which the matching value must be returned. A col_index_num of 1 returns the value in the first column in table_array; a col_index_num of 2 returns the value in the second column in table_array, and so on. If col_index_num is less than 1, VLOOKUP returns the #VALUE! error value; if col_index_num is greater than the number of columns in table_array, VLOOKUP returns the #REF! error value. Range_lookup is a logical value that specifies whether you want VLOOKUP to find an exact match or an approximate match. If TRUE or omitted, an approximate match is returned. In other words, if an exact match is not found, the next largest value that is less than lookup_value is returned. If FALSE, VLOOKUP will find an exact match. If one is not found, the error value #N/A is returned. Remarks If VLOOKUP can't find lookup_value, and range_lookup is TRUE, it uses the largest value that is less than or equal to lookup_value. If lookup_value is smaller than the smallest value in the first column of table_array, VLOOKUP returns the #N/A error value. If VLOOKUP can't find lookup_value, and range_lookup is FALSE, VLOOKUP returns the #N/A value. VLOOKUP(lookup_value,table_array,col_index_num,range_lookup) On the preceding worksheet, where the range A4:C12 is named Range: VLOOKUP(1,Range,1,TRUE) equals 0.946 VLOOKUP(1,Range,2) equals 2.17 VLOOKUP(1,Range,3,TRUE) equals 100 VLOOKUP(.746,Range,3,FALSE) equals 200 VLOOKUP(0.1,Range,2,TRUE) equals #N/A, because 0.1 is less than the smallest value in column A VLOOKUP(2,Range,2,TRUE) equals 1.71
    
    Throws:
    
    FunctionNotSupportedException

Class LookupReferenceCalculator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LookupReferenceCalculator

Method Detail

calcAddress

calcAreas

calcChoose

calcColumn

calcColumns

calcHlookup

calcHyperlink

calcIndex

calcIndirect

calcLookup

calcMatch

calcOffset

calcTranspose

calcRow

calcRows

calcVlookup