org.sbml.jsbml.util

Class StringTools

java.lang.Object

org.sbml.jsbml.util.StringTools

Direct Known Subclasses:

FormulaCompiler, FormulaCompiler, LaTeXCompiler, LaTeXCompiler

public class StringTools
extends java.lang.Object

This class provides a collection of convenient methods for manipulating Strings.

Since:

0.8

Version:

$Rev$

Author:

Andreas Dräger, Nicolas Rodriguez, Clemens Wrzodek

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DECIMAL_FORMAT
private static java.lang.String	newLine New line separator of this operating system
static java.lang.String	REAL_FORMAT
static java.lang.String	SCIENTIFIC_FORMAT
static java.lang.String	underscore The Character '_' as a String.

Constructor Summary

Constructors

Constructor and Description
StringTools()

Method Summary

Modifier and Type	Method and Description
static java.lang.StringBuffer	append(java.lang.StringBuffer k, java.lang.Object... things) Takes the given StringBuffer as input and appends every further Object to it.
static void	append(java.lang.StringBuilder sb, java.lang.Object... elems)
static java.lang.StringBuffer	concat(java.lang.Object... things) This method concatenates two or more Object Strings (obtained by calling Object.toString() if the current Object is not null) into a new StringBuffer.
static java.lang.StringBuilder	concatStringBuilder(java.lang.Object... things) This method concatenates two or more Object Strings (obtained by calling Object.toString() if the current Object is not null) into a new StringBuilder.
static java.lang.String	encodeForHTML(java.lang.String string)
static java.lang.String	fill(int length, char symbol)
static java.lang.String	fill(int length, char symbol, java.lang.String initialString)
private static java.lang.String	fill(int length, char symbol, java.lang.StringBuilder sb) Ensures a minimum size of length for the given stringBuilder.
static java.lang.String	firstLetterLowerCase(java.lang.String name) Returns a String whose first letter is now in lower case.
static java.lang.String	firstLetterUpperCase(java.lang.String name) Returns a String who's first letter is now in upper case.
static java.lang.String	getWordForNumber(long number) Returns the number as an English word.
static java.lang.String	leadingZeros(int length, int number) This method creates a String representation of the given number and inserts as many zero characters as the prefix of this String as needed to result in a String of the given length.
static java.lang.String	newLine()
static boolean	parseSBMLBoolean(java.lang.String valueAsStr) Parses a String into a boolean following the rules of the SBML specifications, section 3.1.2.
static double	parseSBMLDouble(java.lang.String valueAsStr) Parses a String into a double number following the rules of the SBML specifications, section 3.1.5.
static int	parseSBMLInt(java.lang.String valueAsStr) Parses a String into an int number following the rules of the SBML specifications, section 3.1.3.
static short	parseSBMLShort(java.lang.String value) Parses a String into an short number following the rules of the SBML specifications, section 3.1.3.
static java.lang.String	toHTML(java.lang.String string) Returns a HTML formated String, in which each line is at most lineBreak symbols long.
static java.lang.String	toHTML(java.lang.String string, int lineBreak) Returns a HTML formated String, in which each line is at most lineBreak symbols long.
static java.lang.String	toString(double value) Returns a String from the given value that does not contain a point zero at the end if the given value represents an integer number.
static java.lang.String	toString(java.util.Locale locale, double value) Allows for Locale-dependent number formatting.
static java.lang.String	toXMLAnnotationString(java.lang.String annotation) Checks whether a given String fits into the definition of the XML annotation String in SBML.
static java.lang.String	toXMLMessageString(java.lang.String message) Checks whether a given String fits into the definition of the XML message String in SBML.
static java.lang.String	toXMLNotesString(java.lang.String notes) Checks whether a given String fits into the definition of the XML notes String in SBML.
private static java.lang.String	toXMLString(java.lang.String notes, java.lang.String surroundingTagName) Checks whether a given String contain the given surrounding tag.

Methods inherited from class java.lang.Object

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

Field Detail

DECIMAL_FORMAT

public static final java.lang.String DECIMAL_FORMAT

See Also:

Constant Field Values

newLine

private static final java.lang.String newLine

New line separator of this operating system

See Also:

Constant Field Values

REAL_FORMAT

public static final java.lang.String REAL_FORMAT

See Also:

Constant Field Values

SCIENTIFIC_FORMAT

public static final java.lang.String SCIENTIFIC_FORMAT

See Also:

Constant Field Values

underscore

public static final java.lang.String underscore

The Character '_' as a String.

Constructor Detail

StringTools

public StringTools()

Method Detail

append

public static final java.lang.StringBuffer append(java.lang.StringBuffer k,
                                                  java.lang.Object... things)

Takes the given StringBuffer as input and appends every further Object to it.

Parameters:

k -

things -

Returns:

append

public static void append(java.lang.StringBuilder sb,
                          java.lang.Object... elems)

Parameters:

sb -

elems -

concat

public static final java.lang.StringBuffer concat(java.lang.Object... things)

This method concatenates two or more Object Strings (obtained by calling Object.toString() if the current Object is not null) into a new StringBuffer.

Parameters:

things - to be concatenated

Returns:

a new StringBuffer containing all the string-representations of all given Objects.

concatStringBuilder

public static final java.lang.StringBuilder concatStringBuilder(java.lang.Object... things)

This method concatenates two or more Object Strings (obtained by calling Object.toString() if the current Object is not null) into a new StringBuilder.

Parameters:

things - to be concatenated

Returns:

a new StringBuilder containing all the string-representations of all given Objects.

encodeForHTML

public static final java.lang.String encodeForHTML(java.lang.String string)

Parameters:

string -

Returns:

firstLetterLowerCase

public static final java.lang.String firstLetterLowerCase(java.lang.String name)

Returns a String whose first letter is now in lower case.

Parameters:

name -

Returns:

firstLetterUpperCase

public static final java.lang.String firstLetterUpperCase(java.lang.String name)

Returns a String who's first letter is now in upper case.

Parameters:

name -

Returns:

getWordForNumber

public static java.lang.String getWordForNumber(long number)

Returns the number as an English word. Zero is converted to "no". Only positive numbers from 1 to twelve can be converted. All other numbers are just converted to a String containing the number.

Parameters:

number -

Returns:

leadingZeros

public static java.lang.String leadingZeros(int length,
                                            int number)

This method creates a String representation of the given number and inserts as many zero characters as the prefix of this String as needed to result in a String of the given length.

Parameters:

length - the total desired length of the given number String.

number -

Returns:

a String of the given length consisting of a suffix defined by the given number and as many leading zeros as necessary to reach the desired length.

fill

public static java.lang.String fill(int length,
                                    char symbol,
                                    java.lang.String initialString)

Parameters:

length - the desired length of the resulting String

symbol - the symbol to be inserted at the beginning of the initial String multiple times.

initialString - can be null or empty.

Returns:

fill

public static java.lang.String fill(int length,
                                    char symbol)

Parameters:

length -

symbol -

Returns:

fill

private static java.lang.String fill(int length,
                                     char symbol,
                                     java.lang.StringBuilder sb)

Ensures a minimum size of length for the given stringBuilder. Therefore, the given symbol will be put at the beginning of the string, until it reaches the given length.

Parameters:

length -

symbol -

sb -

Returns:

newLine

public static final java.lang.String newLine()

Returns:

parseSBMLBoolean

public static boolean parseSBMLBoolean(java.lang.String valueAsStr)

Parses a String into a boolean following the rules of the SBML specifications, section 3.1.2.

Parameters:

valueAsStr - a boolean as a String

Returns:

the String as a boolean. If the String is not a valid boolean, false is returned.

parseSBMLDouble

public static double parseSBMLDouble(java.lang.String valueAsStr)

Parses a String into a double number following the rules of the SBML specifications, section 3.1.5.

Parameters:

valueAsStr - a double as a String

Returns:

the String as a double. If the String is not a valid double number, Double.NaN is returned.

parseSBMLInt

public static int parseSBMLInt(java.lang.String valueAsStr)

Parses a String into an int number following the rules of the SBML specifications, section 3.1.3.

Parameters:

valueAsStr - an int as a String

Returns:

the String as an int. If the String is not a valid int number, 0 is returned.

parseSBMLShort

public static short parseSBMLShort(java.lang.String value)

Parses a String into an short number following the rules of the SBML specifications, section 3.1.3.

Parameters:

value - an int as a String

Returns:

the String as an short. If the String is not a valid short number, 0 is returned.

toHTML

public static java.lang.String toHTML(java.lang.String string)

Returns a HTML formated String, in which each line is at most lineBreak symbols long.

Parameters:

string -

Returns:

toHTML

public static java.lang.String toHTML(java.lang.String string,
                                      int lineBreak)

Returns a HTML formated String, in which each line is at most lineBreak symbols long.

Parameters:

string -

lineBreak -

Returns:

toString

public static final java.lang.String toString(double value)

Returns a String from the given value that does not contain a point zero at the end if the given value represents an integer number. The returned String displays the number in a Locale -dependent way, i.e., the decimal separator and the symbols to represent the digits are chosen from the system's configuration. Furthermore, a scientific style including 'E' will be used if the value is smaller than 1E-5 or greater than 1E5.

Parameters:

value -

Returns:

toString

public static final java.lang.String toString(java.util.Locale locale,
                                              double value)

Allows for Locale-dependent number formatting.

Parameters:

locale -

value -

Returns:

toXMLNotesString

public static java.lang.String toXMLNotesString(java.lang.String notes)

Checks whether a given String fits into the definition of the XML notes String in SBML. If not, this method will surround the given String with the minimal definition of a valid notes String.

Parameters:

notes - the String to be checked and possibly modified.

Returns:

A String that will be surrounded by the XML definition of a notes String in SBML, i.e.,

 <notes>
   <body xmlns="http://www.w3.org/1999/xhtml">
     <p>the original notes</p>
   </body>
 </notes>
 

If the given argument already suffices the definition of XML Strings in SBML, nothing will be changed.

toXMLMessageString

public static java.lang.String toXMLMessageString(java.lang.String message)

Checks whether a given String fits into the definition of the XML message String in SBML. If not, this method will surround the given String with the minimal definition of a valid message String.

Parameters:

message - the String to be checked and possibly modified.

Returns:

A String that will be surrounded by the XML definition of a notes String in SBML, i.e.,

 <message>
   <body xmlns="http://www.w3.org/1999/xhtml">
     <p>the original message</p>
   </body>
 </message>
 

If the given argument already suffices the definition of XML Strings in SBML, nothing will be changed.

toXMLString

private static java.lang.String toXMLString(java.lang.String notes,
                                            java.lang.String surroundingTagName)

Checks whether a given String contain the given surrounding tag. If not, this method will surround the given String with the minimal definition of a valid XML String.

Parameters:

notes - the String to be checked and possibly modified.

surroundingTagName -

Returns:

A String that will be surrounded by the XML definition of a notes String in SBML, i.e.,

 <tag>
   <body xmlns="http://www.w3.org/1999/xhtml">
     <p>the original notes</p>
   </body>
 </tag>
 

If the given argument already suffices the definition of XML Strings in SBML, nothing will be changed.

toXMLAnnotationString

public static java.lang.String toXMLAnnotationString(java.lang.String annotation)

Checks whether a given String fits into the definition of the XML annotation String in SBML. If not, this method will surround the given String with the minimal definition of a valid annotation String.

Parameters:

annotation - - the String to be checked and possibly modified.

Returns:

the argument surrounded by the annotation XML element if needed.

Throws:

java.lang.IllegalArgumentException - if the String passed as argument is not XML