CommonUtil (Webharvest 2.0-wso2v4 API)

java.lang.Object
- org.webharvest.utils.CommonUtil

```
public class CommonUtil
extends Object
```
Basic evaluation utilities

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CommonUtil.IntPair
Contains pair of intger values

Nested Classes
Modifier and Type	Class and Description
`static class`	`CommonUtil.IntPair` Contains pair of intger values

Constructor Summary

Constructors
Constructor and Description

CommonUtil()

Constructors
Constructor and Description
`CommonUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`adaptFilename(String filePath)`
`static int`	`countChars(String text, char ch, int from, int to)` Counts number of specified characters in give text.
`static Variable`	`createVariable(Object value)` Creates appropriate AbstractVariable instance for the specified object.
`static String`	`encodeUrl(String url, String charset)`
`static String`	`escapeXml(String s)` Escapes XML string - special characters: &'"<> are replaced with XML escape sequences: & ' " < >
`static boolean`	`existsInStringArray(String[] array, String s, boolean caseSensitive)` Checks if specified string exists in given array
`static int`	`findValueInCollection(Collection c, Object value)` Searches specified value in given collection
`static String`	`fullUrl(String pageUrl, String link)` Calculates full URL for specified page URL and link which could be full, absolute or relative like there can be found in A or IMG tags.
`static String`	`getAbsoluteFilename(String workingPath, String filePath)` For the goven working path and file path returns absolute file path.
`static boolean`	`getBooleanValue(String value, boolean defaultValue)` Reads boolean value from string
`static String`	`getClassName(Object o)` Returns class name without packages for the specified object
`static String`	`getDirectoryFromPath(String path)` Extracts a filename and directory from an absolute path.
`static double`	`getDoubleValue(String value, double defaultValue)` Reads double value from string
`static String`	`getFileFromPath(String path)` Extracts a filename from an absolute path.
`static int`	`getIntValue(String value, int defaultValue)` Reads integer value from string
`static String`	`getValidIdentifier(String value)` For the given string creates valid identifier name.
`static boolean`	`isBooleanTrue(String value)` Checks if specified string value represents boolean true value.
`static boolean`	`isEmpty(String s)`
`static boolean`	`isEmptyString(Object o)`
`static boolean`	`isFullUrl(String link)` Checks if specified link is full URL.
`static boolean`	`isPathAbsolute(String path)` Checks if specified file path is absolute.
`static boolean`	`isValidXmlIdentifier(String name)` Checks if given string is valid XML identifier, i.e.
`static String`	`nvl(Object value, String defaultValue)`
`static byte[]`	`readBytesFromFile(File file)`
`static String`	`readStringFromFile(File file, String encoding)`
`static String`	`readStringFromUrl(URL url)` Reads content from specified URL
`static String`	`replicate(String s, int count)`
`static void`	`saveStringToFile(File file, String content, String charset)` Saves specified content to the file with specified charset.
`static String`	`serializeItem(net.sf.saxon.om.Item item)` Serializes item after XPath or XQuery processor execution using Saxon.
`static String[]`	`tokenize(String s, String delimiters)` Tokenize given string for specified delimiter(s).
`static String[]`	`tokenize(String s, String delimiters, boolean trimTokens, boolean allowEmptyTokens)`

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

- Constructor Detail
  - CommonUtil
```
public CommonUtil()
```
- Method Detail
  - isEmptyString
```
public static boolean isEmptyString(Object o)
```
  - nvl
```
public static String nvl(Object value,
                         String defaultValue)
```
  - adaptFilename
```
public static String adaptFilename(String filePath)
```
  - isEmpty
```
public static boolean isEmpty(String s)
```
  - isValidXmlIdentifier
```
public static boolean isValidXmlIdentifier(String name)
```
    Checks if given string is valid XML identifier, i.e. it can be valid XML tag or attribute name.
    
    Parameters:
    
    name - String to be checked
    
    Returns:
    
    True if string is valid XML identifier, false otherwise.
  - isPathAbsolute
```
public static boolean isPathAbsolute(String path)
```
    Checks if specified file path is absolute. Criteria for recogning absolute file paths is that i starts with /, \, or X: where X is some letter.
    
    Parameters:
    
    path -
    
    Returns:
    
    True, if specified filepath is absolute, false otherwise.
  - getAbsoluteFilename
```
public static String getAbsoluteFilename(String workingPath,
                                         String filePath)
```
    For the goven working path and file path returns absolute file path.
    
    Parameters:
    
    workingPath -
    
    filePath -
    
    Returns:
    
    Absolute path of the second parameter according to absolute working path.
  - getDirectoryFromPath
```
public static String getDirectoryFromPath(String path)
```
    Extracts a filename and directory from an absolute path.
  - getFileFromPath
```
public static String getFileFromPath(String path)
```
    Extracts a filename from an absolute path.
  - getClassName
```
public static String getClassName(Object o)
```
    Returns class name without packages for the specified object
  - replicate
```
public static String replicate(String s,
                               int count)
```
  - encodeUrl
```
public static String encodeUrl(String url,
                               String charset)
```
  - isBooleanTrue
```
public static boolean isBooleanTrue(String value)
```
    Checks if specified string value represents boolean true value.
    
    Returns:
    
    If specified string equals (ignoring case) to 1, true or yes then true, otherwise false.
  - getBooleanValue
```
public static boolean getBooleanValue(String value,
                                      boolean defaultValue)
```
    Reads boolean value from string
    
    Parameters:
    
    value -
    
    defaultValue - value to be returned if string value is not recognized
  - getIntValue
```
public static int getIntValue(String value,
                              int defaultValue)
```
    Reads integer value from string
    
    Parameters:
    
    value -
    
    defaultValue - value to be returned if string value is not valid integer
  - getDoubleValue
```
public static double getDoubleValue(String value,
                                    double defaultValue)
```
    Reads double value from string
    
    Parameters:
    
    value -
    
    defaultValue - value to be returned if string value is not valid double
  - escapeXml
```
public static String escapeXml(String s)
```
    Escapes XML string - special characters: &'"<> are replaced with XML escape sequences: & ' " < >
  - serializeItem
```
public static String serializeItem(net.sf.saxon.om.Item item)
                            throws net.sf.saxon.trans.XPathException
```
    Serializes item after XPath or XQuery processor execution using Saxon.
    
    Throws:
    
    net.sf.saxon.trans.XPathException
  - readStringFromFile
```
public static String readStringFromFile(File file,
                                        String encoding)
                                 throws IOException
```
    Throws:
    
    IOException
  - saveStringToFile
```
public static void saveStringToFile(File file,
                                    String content,
                                    String charset)
                             throws IOException
```
    Saves specified content to the file with specified charset.
    
    Parameters:
    
    file -
    
    content -
    
    charset -
    
    Throws:
    
    IOException
    
    UnsupportedEncodingException
  - readBytesFromFile
```
public static byte[] readBytesFromFile(File file)
                                throws IOException
```
    Throws:
    
    IOException
  - isFullUrl
```
public static boolean isFullUrl(String link)
```
    Checks if specified link is full URL.
    
    Parameters:
    
    link -
    
    Returns:
    
    True, if full URl, false otherwise.
  - fullUrl
```
public static String fullUrl(String pageUrl,
                             String link)
```
    Calculates full URL for specified page URL and link which could be full, absolute or relative like there can be found in A or IMG tags.
  - createVariable
```
public static Variable createVariable(Object value)
```
    Creates appropriate AbstractVariable instance for the specified object. For colleactions and arrays ListVariable instance is returned, for null it is an EmptyVariable, and for others it is NodeVariable that wraps specified object.
    
    Parameters:
    
    value -
  - readStringFromUrl
```
public static String readStringFromUrl(URL url)
                                throws IOException
```
    Reads content from specified URL
    
    Parameters:
    
    url -
    
    Returns:
    
    Read content as string.
    
    Throws:
    
    IOException
  - countChars
```
public static int countChars(String text,
                             char ch,
                             int from,
                             int to)
```
    Counts number of specified characters in give text.
    
    Parameters:
    
    text - Text to be parsed
    
    ch - Character to be counted
    
    from - Text offset
    
    to - Text end
    
    Returns:
    
    Number of character occurences in given text.
  - existsInStringArray
```
public static boolean existsInStringArray(String[] array,
                                          String s,
                                          boolean caseSensitive)
```
    Checks if specified string exists in given array
    
    Parameters:
    
    array - Array of strings
    
    s - String to be looked for in array
    
    caseSensitive - Tells whether search is case sensitive
    
    Returns:
    
    True if string is found in array, false otherwise
  - tokenize
```
public static String[] tokenize(String s,
                                String delimiters)
```
    Tokenize given string for specified delimiter(s).
    
    Parameters:
    
    s - String to be tokenized
    
    delimiters - Delimiter character(s)
    
    Returns:
    
    Array of token strings
  - tokenize
```
public static String[] tokenize(String s,
                                String delimiters,
                                boolean trimTokens,
                                boolean allowEmptyTokens)
```
  - getValidIdentifier
```
public static String getValidIdentifier(String value)
```
    For the given string creates valid identifier name. All invalid characters are transformed to underscores, and valid characters are preserved.
    
    Parameters:
    
    value - String to be transformed to valid identifier
    
    Returns:
    
    Valid identifier name made of specified string.
  - findValueInCollection
```
public static int findValueInCollection(Collection c,
                                        Object value)
```
    Searches specified value in given collection
    
    Parameters:
    
    c - Collection to be searched
    
    value - Object searched for
    
    Returns:
    
    First index in collection of object found, or -1 if collection doesn't contain it

Class CommonUtil

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommonUtil

Method Detail

isEmptyString

nvl

adaptFilename

isEmpty

isValidXmlIdentifier

isPathAbsolute

getAbsoluteFilename

getDirectoryFromPath

getFileFromPath

getClassName

replicate

encodeUrl

isBooleanTrue

getBooleanValue

getIntValue

getDoubleValue

escapeXml

serializeItem

readStringFromFile

saveStringToFile

readBytesFromFile

isFullUrl

fullUrl

createVariable

readStringFromUrl

countChars

existsInStringArray

tokenize

tokenize

getValidIdentifier

findValueInCollection