org.jxls.util

Class Util

java.lang.Object

org.jxls.util.Util

public class Util
extends Object

Utility class with various helper methods used by other classes

Since:

2/3/12

Author:

Leonid Vysochyn

Field Summary

Fields

Modifier and Type	Field and Description
static String	regexAreaRef
static Pattern	regexAreaRefPattern
static String	regexCellRef
static String	regexCellRefExcludingJointed
static String	regexExcludePrefixSymbols
static String	regexJointedCellRef
static String	regexJointedLookBehind
static String	regexSimpleCellRef

Constructor Summary

Constructors

Constructor and Description
Util()

Method Summary

Modifier and Type	Method and Description
static int	countOccurences(String str, char ch)
static String	createTargetCellRef(List<CellRef> targetCellDataList)
static List<CellRef>	createTargetCellRefListByColumn(CellRef targetFormulaCellRef, List<CellRef> targetCells, List<CellRef> cellRefsToExclude)
static boolean	formulaContainsJointedCellRef(String formula)
static List<String>	getCellRefsFromJointedCellRef(String jointedCellRef) Parses a "jointed cell" reference and extracts individual cell references
static List<String>	getFormulaCellRefs(String formula) Parses a formula and returns a list of cell names used in it E.g.
static List<String>	getJointedCellRefs(String formula) Parses a formula to extract a list of so called "jointed cells" The jointed cells are cells combined with a special notation "U_(cell1, cell2)" into a single cell They are used in formulas like this "$[SUM(U_(F8,F13))]".
static Object	getObjectProperty(Object obj, String propertyName)
static Object	getObjectProperty(Object obj, String propertyName, boolean failSilently)
static String	getStrictCellNameRegex(String name)
static List<List<CellRef>>	groupByColRange(List<CellRef> cellRefList)
static List<List<CellRef>>	groupByRanges(List<CellRef> cellRefList, int targetRangeCount) Groups a list of cell references into a list ranges which can be used in a formula substitution
static List<List<CellRef>>	groupByRowRange(List<CellRef> cellRefList)
static Collection<GroupData>	groupCollection(Collection<?> collection, String groupProperty, String groupOrder)
static Collection<GroupData>	groupIterable(Iterable<?> iterable, String groupProperty, String groupOrder)
static Boolean	isConditionTrue(ExpressionEvaluator evaluator, Context context)
static Boolean	isConditionTrue(ExpressionEvaluator evaluator, String condition, Context context)
static String	joinStrings(List<String> strings, String separator)
static void	setObjectProperty(Object obj, String propertyName, String propertyValue)
static void	setObjectProperty(Object obj, String propertyName, String propertyValue, boolean ignoreNonExisting)
static String	sheetNameRegex(Map.Entry<CellRef,List<CellRef>> cellRefEntry)
static byte[]	toByteArray(InputStream stream) Reads all the data from the input stream, and returns the bytes read.
static Collection<?>	transformToCollectionObject(ExpressionEvaluator expressionEvaluator, String collectionName, Context context)
static Iterable<Object>	transformToIterableObject(ExpressionEvaluator expressionEvaluator, String collectionName, Context context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

regexJointedLookBehind

public static final String regexJointedLookBehind

See Also:

Constant Field Values

regexSimpleCellRef

public static final String regexSimpleCellRef

See Also:

Constant Field Values

regexCellRef

public static final String regexCellRef

See Also:

Constant Field Values

regexAreaRef

public static final String regexAreaRef

See Also:

Constant Field Values

regexAreaRefPattern

public static final Pattern regexAreaRefPattern

regexCellRefExcludingJointed

public static final String regexCellRefExcludingJointed

See Also:

Constant Field Values

regexJointedCellRef

public static final String regexJointedCellRef

See Also:

Constant Field Values

regexExcludePrefixSymbols

public static final String regexExcludePrefixSymbols

See Also:

Constant Field Values

Constructor Detail

Util

public Util()

Method Detail

getFormulaCellRefs

public static List<String> getFormulaCellRefs(String formula)

Parses a formula and returns a list of cell names used in it E.g. for formula "B4*(1+C4)" the returned list will contain "B4", "C4"

Parameters:

formula - string

Returns:

a list of cell names used in the formula

getJointedCellRefs

public static List<String> getJointedCellRefs(String formula)

Parses a formula to extract a list of so called "jointed cells" The jointed cells are cells combined with a special notation "U_(cell1, cell2)" into a single cell They are used in formulas like this "$[SUM(U_(F8,F13))]". Here the formula will use both F8 and F13 source cells to calculate the sum

Parameters:

formula - a formula string to parse

Returns:

a list of jointed cells used in the formula

getCellRefsFromJointedCellRef

public static List<String> getCellRefsFromJointedCellRef(String jointedCellRef)

Parses a "jointed cell" reference and extracts individual cell references

Parameters:

jointedCellRef - a jointed cell reference to parse

Returns:

a list of cell names extracted from the jointed cell reference

formulaContainsJointedCellRef

public static boolean formulaContainsJointedCellRef(String formula)

createTargetCellRef

public static String createTargetCellRef(List<CellRef> targetCellDataList)

joinStrings

public static String joinStrings(List<String> strings,
                                 String separator)

groupByRanges

public static List<List<CellRef>> groupByRanges(List<CellRef> cellRefList,
                                                int targetRangeCount)

Groups a list of cell references into a list ranges which can be used in a formula substitution

Parameters:

cellRefList - a list of cell references

targetRangeCount - a number of ranges to use when grouping

Returns:

a list of cell ranges grouped by row or by column

groupByColRange

public static List<List<CellRef>> groupByColRange(List<CellRef> cellRefList)

groupByRowRange

public static List<List<CellRef>> groupByRowRange(List<CellRef> cellRefList)

isConditionTrue

public static Boolean isConditionTrue(ExpressionEvaluator evaluator,
                                      String condition,
                                      Context context)

isConditionTrue

public static Boolean isConditionTrue(ExpressionEvaluator evaluator,
                                      Context context)

setObjectProperty

public static void setObjectProperty(Object obj,
                                     String propertyName,
                                     String propertyValue,
                                     boolean ignoreNonExisting)

setObjectProperty

public static void setObjectProperty(Object obj,
                                     String propertyName,
                                     String propertyValue)
                              throws NoSuchMethodException,
                                     InvocationTargetException,
                                     IllegalAccessException

Throws:

NoSuchMethodException

InvocationTargetException

IllegalAccessException

getObjectProperty

public static Object getObjectProperty(Object obj,
                                       String propertyName,
                                       boolean failSilently)

getObjectProperty

public static Object getObjectProperty(Object obj,
                                       String propertyName)
                                throws NoSuchMethodException,
                                       InvocationTargetException,
                                       IllegalAccessException

Throws:

NoSuchMethodException

InvocationTargetException

IllegalAccessException

groupCollection

public static Collection<GroupData> groupCollection(Collection<?> collection,
                                                    String groupProperty,
                                                    String groupOrder)

groupIterable

public static Collection<GroupData> groupIterable(Iterable<?> iterable,
                                                  String groupProperty,
                                                  String groupOrder)

toByteArray

public static byte[] toByteArray(InputStream stream)
                          throws IOException

Reads all the data from the input stream, and returns the bytes read.

Parameters:

stream - -

Returns:

byte array

Throws:

IOException - -

transformToCollectionObject

public static Collection<?> transformToCollectionObject(ExpressionEvaluator expressionEvaluator,
                                                        String collectionName,
                                                        Context context)

sheetNameRegex

public static String sheetNameRegex(Map.Entry<CellRef,List<CellRef>> cellRefEntry)

createTargetCellRefListByColumn

public static List<CellRef> createTargetCellRefListByColumn(CellRef targetFormulaCellRef,
                                                            List<CellRef> targetCells,
                                                            List<CellRef> cellRefsToExclude)

countOccurences

public static int countOccurences(String str,
                                  char ch)

transformToIterableObject

public static Iterable<Object> transformToIterableObject(ExpressionEvaluator expressionEvaluator,
                                                         String collectionName,
                                                         Context context)

getStrictCellNameRegex

public static String getStrictCellNameRegex(String name)