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

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) Calculates a number of occurences of a symbol in the string
static String	createTargetCellRef(List<CellRef> targetCellDataList) Combines a list of cell references into a range E.g.
static List<CellRef>	createTargetCellRefListByColumn(CellRef targetFormulaCellRef, List<CellRef> targetCells, List<CellRef> cellRefsToExclude) Creates a list of target formula cell references
static boolean	formulaContainsJointedCellRef(String formula) Checks if the formula contains jointed cell references Jointed references have format U_(cell1, cell2) e.g.
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) Gets value of the passed object by the given property name.
static Object	getObjectProperty(Object obj, String propertyName, boolean failSilently) Gets value of the passed object by the given property name.
static List<String>	getSheetsNameOfMultiSheetTemplate(List<Area> areaList) Return names of all multi sheet template
static String	getStrictCellNameRegex(String name)
static List<List<CellRef>>	groupByColRange(List<CellRef> cellRefList) Groups a list of cell references in a column into a list of ranges
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) Groups a list of cell references in a row into a list of ranges
static Collection<GroupData>	groupCollection(Collection<?> collection, String groupProperty, String groupOrder) Similar to groupIterable(Iterable, String, String) method but works for collections
static Collection<GroupData>	groupIterable(Iterable<?> iterable, String groupProperty, String groupOrder) Groups items from an iterable collection using passed group property and group order
static Boolean	isConditionTrue(ExpressionEvaluator evaluator, Context context) Evaluates if the passed condition is true
static Boolean	isConditionTrue(ExpressionEvaluator evaluator, String condition, Context context) Evaluates if the passed condition is true
static String	joinStrings(List<String> strings, String separator) Joins strings with a separator
static void	setObjectProperty(Object obj, String propertyName, String propertyValue) Dynamically sets an object property via reflection
static void	setObjectProperty(Object obj, String propertyName, String propertyValue, boolean ignoreNonExisting) Dynamically sets an object property via reflection
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) Evaluates passed collection name into a Collection object
static Iterable<Object>	transformToIterableObject(ExpressionEvaluator expressionEvaluator, String collectionName, Context context) Evaluates the passed collection name into an Iterable object

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)

Checks if the formula contains jointed cell references Jointed references have format U_(cell1, cell2) e.g. $[SUM(U_(F8,F13))]

Parameters:

formula - string

Returns:

true if the formula contains jointed cell references

createTargetCellRef

public static String createTargetCellRef(List<CellRef> targetCellDataList)

Combines a list of cell references into a range E.g. for cell references A1, A2, A3, A4 it returns A1:A4

Parameters:

targetCellDataList - -

Returns:

a range containing all the cell references if such range exists or otherwise the passed cells separated by commas

joinStrings

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

Joins strings with a separator

Parameters:

strings - -

separator - -

Returns:

a string consisting of all the passed strings joined with the 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)

Groups a list of cell references in a column into a list of ranges

Parameters:

cellRefList - -

Returns:

a list of cell reference groups

groupByRowRange

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

Groups a list of cell references in a row into a list of ranges

Parameters:

cellRefList - -

Returns:

-

isConditionTrue

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

Evaluates if the passed condition is true

Parameters:

evaluator - expression evaluator instance

condition - condition string

context - Jxls context to use for evaluation

Returns:

true if the condition is evaluated to true or false otherwise

isConditionTrue

public static Boolean isConditionTrue(ExpressionEvaluator evaluator,
                                      Context context)

Evaluates if the passed condition is true

Parameters:

evaluator - -

context - Jxls context to use for evaluation

Returns:

true if the condition is evaluated to true or false otherwise

setObjectProperty

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

Dynamically sets an object property via reflection

Parameters:

obj - -

propertyName - -

propertyValue - -

ignoreNonExisting - -

setObjectProperty

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

Dynamically sets an object property via reflection

Parameters:

obj - -

propertyName - -

propertyValue - -

Throws:

NoSuchMethodException - -

InvocationTargetException - -

IllegalAccessException - -

getObjectProperty

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

Gets value of the passed object by the given property name.

Parameters:

obj - Map, DynaBean or Java bean

propertyName - -

failSilently - -

Returns:

value (can be null)

getObjectProperty

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

Gets value of the passed object by the given property name.

Parameters:

obj - Map, DynaBean or Java bean

propertyName - -

Returns:

value (can be null)

Throws:

NoSuchMethodException - -

InvocationTargetException - -

IllegalAccessException - -

groupCollection

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

Similar to groupIterable(Iterable, String, String) method but works for collections

Parameters:

collection - -

groupProperty - -

groupOrder - -

Returns:

a collection of group data objects

groupIterable

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

Groups items from an iterable collection using passed group property and group order

Parameters:

iterable - iterable object

groupProperty - property to use to group the items

groupOrder - an order to sort the groups

Returns:

a collection of group data objects

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)

Evaluates passed collection name into a Collection object

Parameters:

expressionEvaluator - -

collectionName - -

context - -

Returns:

an evaluated Collection instance

sheetNameRegex

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

Parameters:

cellRefEntry - -

Returns:

the sheet name regular expression string

createTargetCellRefListByColumn

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

Creates a list of target formula cell references

Parameters:

targetFormulaCellRef - -

targetCells - -

cellRefsToExclude - -

Returns:

-

countOccurences

public static int countOccurences(String str,
                                  char ch)

Calculates a number of occurences of a symbol in the string

Parameters:

str - -

ch - -

Returns:

-

transformToIterableObject

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

Evaluates the passed collection name into an Iterable object

Parameters:

expressionEvaluator - -

collectionName - -

context - -

Returns:

an iterable object from the Context under given name

getStrictCellNameRegex

public static String getStrictCellNameRegex(String name)

Parameters:

name - -

Returns:

regular expression to detect the passed cell name

getSheetsNameOfMultiSheetTemplate

public static List<String> getSheetsNameOfMultiSheetTemplate(List<Area> areaList)

Return names of all multi sheet template

Parameters:

areaList - list of area

Returns:

string array