com.dragosmatachescu.hyperionUtils
Class HyperionString

java.lang.Object
  com.dragosmatachescu.hyperionUtils.HyperionString

public class HyperionString

extends java.lang.Object

Wrapper class for java.lang.String most interesting methods that can be used in Hyperion Essbase as UDF - User Defined Functions.

Naming conventions:

- if the java JRE class is called String for example, the correspondent class will be called HyperionString.

- if the java JRE method is called compareTo for example, the correspondent wrapper method will be called z_compareTo, and the essbase UDF function will be called @JString_compareTo.

- whenever possible, the wrapper function will have the same parameters as the JRE function, except the first parameter will be the java object and the function will be static.

Ex:
str1.compareTo(str2);
becomes
z_compareTo(str1, str2).

Implements static wrappers for the following methods in String object as defined in J2SE 1.4.2:

1. int compareTo(String anotherString);
2. int compareToIgnoreCase(String str);
3. String concat(String str);
4. boolean endsWith(String suffix);
5. boolean equals(Object anObject);
6. boolean equalsIgnoreCase(String anotherString);
7. int indexOf(String str, int fromIndex);
8. int lastIndexOf(String str, int fromIndex);
9. int length();
10. boolean matches(String regex);
11. boolean regionMatches(boolean ignoreCase, int toffset, String other, int ooffset, int len);
12. String replaceAll(String regex, String replacement);
13. String replaceFirst(String regex, String replacement);
14. String[] split(String regex);
15. boolean startsWith(String prefix, int toffset);
16. String substring(int beginIndex, int endIndex);
17. String toLowerCase();
18. String toUpperCase();
19. String trim();

20. static String valueOf(boolean b);
21. static String valueOf(double d);
22. static String valueOf(int i);
23. static String valueOf(long l);

24. static boolean getBoolean(String name); (from class Boolean)
25. static double parseDouble(String s); (from class Double)
26. static int parseInt(String s); (from class Integer)
27. static long parseLong(String s); (from class Long)

In case of exception, methods that return int will return -999999, functions that return boolean will return false and functions that return String will return firststring.

For conversion methods (20-27), in case of exception they return empty string or 0/false.

Author:

Dragos Matachescu

Constructor Summary

HyperionString()

Method Summary

static void	main(java.lang.String[] args) There is no function that returns void or has benefic side-effects from running, no need for a main method to be able to use RUNJAVA in calcscript Essbase.
static java.lang.String	z_BooleanToString(boolean b) Wrapper for: static String valueOf(boolean b).
static int	z_compareTo(java.lang.String firststring, java.lang.String anotherString) Wrapper for: int compareTo(String anotherString).
static int	z_compareToIgnoreCase(java.lang.String firststring, java.lang.String str) Wrapper for: int compareToIgnoreCase(String str).
static java.lang.String	z_concat(java.lang.String firststring, java.lang.String str) Wrapper for: String concat(String str).
static java.lang.String	z_DoubleToString(double d) Wrapper for: static String valueOf(double d).
static boolean	z_endsWith(java.lang.String firststring, java.lang.String suffix) Wrapper for: boolean endsWith(String suffix).
static boolean	z_equals(java.lang.String firststring, java.lang.String anObject) Wrapper for: boolean equals(Object anObject).
static boolean	z_equalsIgnoreCase(java.lang.String firststring, java.lang.String anotherString) Wrapper for: boolean equalsIgnoreCase(String anotherString).
static int	z_indexOf(java.lang.String firststring, java.lang.String str, int fromIndex) Wrapper for: int indexOf(String str, int fromIndex).
static java.lang.String	z_IntToString(int i) Wrapper for: static String valueOf(int i).
static int	z_lastIndexOf(java.lang.String firststring, java.lang.String str, int fromIndex) Wrapper for: int lastIndexOf(String str, int fromIndex).
static int	z_length(java.lang.String firststring) Wrapper for: int length().
static java.lang.String	z_LongToString(long l) Wrapper for: static String valueOf(long l).
static boolean	z_matches(java.lang.String firststring, java.lang.String regex) Wrapper for: boolean matches(String regex).
static boolean	z_regionMatches(java.lang.String firststring, boolean ignoreCase, int toffset, java.lang.String other, int ooffset, int len) Wrapper for: boolean regionMatches(boolean ignoreCase, int toffset, String other, int ooffset, int len).
static java.lang.String	z_replaceAll(java.lang.String firststring, java.lang.String regex, java.lang.String replacement) Wrapper for: String replaceAll(String regex, String replacement).
static java.lang.String	z_replaceFirst(java.lang.String firststring, java.lang.String regex, java.lang.String replacement) Wrapper for: String replaceFirst(String regex, String replacement).
static java.lang.String	z_split(java.lang.String firststring, java.lang.String regex, int index) Pseudo-wrapper for: String[] split(String regex).
static boolean	z_startsWith(java.lang.String firststring, java.lang.String prefix, int toffset) Wrapper for: boolean startsWith(String prefix, int toffset).
static boolean	z_StringToBoolean(java.lang.String name) Wrapper for: static boolean Boolean.getBoolean(String name).
static double	z_StringToDouble(java.lang.String s) Wrapper for: static double Double.parseDouble(String s).
static int	z_StringToInt(java.lang.String s) Wrapper for: static int Integer.parseInt(String s).
static long	z_StringToLong(java.lang.String s) Wrapper for: static long Long.parseLong(String s).
static java.lang.String	z_substring(java.lang.String firststring, int beginIndex, int endIndex) Wrapper for: String substring(int beginIndex, int endIndex).
static java.lang.String	z_toLowerCase(java.lang.String firststring) Wrapper for: String toLowerCase().
static java.lang.String	z_toUpperCase(java.lang.String firststring) Wrapper for: String toUpperCase().
static java.lang.String	z_trim(java.lang.String firststring) Wrapper for: String trim().

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperionString

public HyperionString()

Method Detail

z_compareTo

public static int z_compareTo(java.lang.String firststring,
                              java.lang.String anotherString)

Wrapper for:
int compareTo(String anotherString).

z_compareToIgnoreCase

public static int z_compareToIgnoreCase(java.lang.String firststring,
                                        java.lang.String str)

Wrapper for:
int compareToIgnoreCase(String str).

z_concat

public static java.lang.String z_concat(java.lang.String firststring,
                                        java.lang.String str)

Wrapper for:
String concat(String str).

z_endsWith

public static boolean z_endsWith(java.lang.String firststring,
                                 java.lang.String suffix)

Wrapper for:
boolean endsWith(String suffix).

z_equals

public static boolean z_equals(java.lang.String firststring,
                               java.lang.String anObject)

Wrapper for:
boolean equals(Object anObject).

z_equalsIgnoreCase

public static boolean z_equalsIgnoreCase(java.lang.String firststring,
                                         java.lang.String anotherString)

Wrapper for:
boolean equalsIgnoreCase(String anotherString).

z_indexOf

public static int z_indexOf(java.lang.String firststring,
                            java.lang.String str,
                            int fromIndex)

Wrapper for:
int indexOf(String str, int fromIndex).

z_lastIndexOf

public static int z_lastIndexOf(java.lang.String firststring,
                                java.lang.String str,
                                int fromIndex)

Wrapper for:
int lastIndexOf(String str, int fromIndex).

z_length

public static int z_length(java.lang.String firststring)

Wrapper for:
int length().

z_matches

public static boolean z_matches(java.lang.String firststring,
                                java.lang.String regex)

Wrapper for:
boolean matches(String regex).

z_regionMatches

public static boolean z_regionMatches(java.lang.String firststring,
                                      boolean ignoreCase,
                                      int toffset,
                                      java.lang.String other,
                                      int ooffset,
                                      int len)

Wrapper for:
boolean regionMatches(boolean ignoreCase, int toffset, String other, int ooffset, int len).

z_replaceAll

public static java.lang.String z_replaceAll(java.lang.String firststring,
                                            java.lang.String regex,
                                            java.lang.String replacement)

Wrapper for:
String replaceAll(String regex, String replacement).

z_replaceFirst

public static java.lang.String z_replaceFirst(java.lang.String firststring,
                                              java.lang.String regex,
                                              java.lang.String replacement)

Wrapper for:
String replaceFirst(String regex, String replacement).

z_split

public static java.lang.String z_split(java.lang.String firststring,
                                       java.lang.String regex,
                                       int index)

Pseudo-wrapper for:
String[] split(String regex).

After splitting the string, from the resulting array returns only the string at the index "index"

z_startsWith

public static boolean z_startsWith(java.lang.String firststring,
                                   java.lang.String prefix,
                                   int toffset)

Wrapper for:
boolean startsWith(String prefix, int toffset).

z_substring

public static java.lang.String z_substring(java.lang.String firststring,
                                           int beginIndex,
                                           int endIndex)

Wrapper for:
String substring(int beginIndex, int endIndex).

z_toLowerCase

public static java.lang.String z_toLowerCase(java.lang.String firststring)

Wrapper for:
String toLowerCase().

z_toUpperCase

public static java.lang.String z_toUpperCase(java.lang.String firststring)

Wrapper for:
String toUpperCase().

z_trim

public static java.lang.String z_trim(java.lang.String firststring)

Wrapper for:
String trim().

z_BooleanToString

public static java.lang.String z_BooleanToString(boolean b)

Wrapper for:
static String valueOf(boolean b).

z_DoubleToString

public static java.lang.String z_DoubleToString(double d)

Wrapper for:
static String valueOf(double d).

z_IntToString

public static java.lang.String z_IntToString(int i)

Wrapper for:
static String valueOf(int i).

z_LongToString

public static java.lang.String z_LongToString(long l)

Wrapper for:
static String valueOf(long l).

z_StringToBoolean

public static boolean z_StringToBoolean(java.lang.String name)

Wrapper for:
static boolean Boolean.getBoolean(String name).

z_StringToDouble

public static double z_StringToDouble(java.lang.String s)

Wrapper for:
static double Double.parseDouble(String s).

z_StringToInt

public static int z_StringToInt(java.lang.String s)

Wrapper for:
static int Integer.parseInt(String s).

z_StringToLong

public static long z_StringToLong(java.lang.String s)

Wrapper for:
static long Long.parseLong(String s).

main

public static void main(java.lang.String[] args)

There is no function that returns void or has benefic side-effects from running, no need for a main method to be able to use RUNJAVA in calcscript Essbase.