edu.stanford.nlp.util

Class StringUtils

java.lang.Object

edu.stanford.nlp.util.StringUtils

public class StringUtils
extends java.lang.Object

StringUtils is a class for random String things, including output formatting and command line argument parsing.

Many of these methods will be familiar to perl users: join(Iterable), split(String, String), trim(String, int), find(String, String), lookingAt(String, String), and matches(String, String).

There are also useful methods for padding Strings/Objects with spaces on the right or left for printing even-width table columns: padLeft(int, int), pad(String, int).

Example: print a comma-separated list of numbers:

System.out.println(StringUtils.pad(nums, ", "));

Example: print a 2D array of numbers with 8-char cells:

for(int i = 0; i < nums.length; i++) {
for(int j = 0; j < nums[i].length; j++) {
System.out.print(StringUtils.leftPad(nums[i][j], 8));

System.out.println();


Version:

2006/02/03

Author:

Dan Klein, Christopher Manning, Tim Grow (grow@stanford.edu), Chris Cox

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	EMPTY_STRING_ARRAY

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.String[]>	argsToMap(java.lang.String[] args) Parses command line arguments into a Map.
static java.util.Map<java.lang.String,java.lang.String[]>	argsToMap(java.lang.String[] args, java.util.Map<java.lang.String,java.lang.Integer> flagsToNumArgs) Parses command line arguments into a Map.
static java.util.Properties	argsToProperties(java.lang.String... args) In this version each flag has zero or one argument.
static java.util.Properties	argsToProperties(java.lang.String[] args, java.util.Map<java.lang.String,java.lang.Integer> flagsToNumArgs) Analogous to argsToMap(java.lang.String[]).
static java.util.Properties	argsToPropertiesWithResolve(java.lang.String[] args) convert args to properties with variable names resolved.
static java.lang.String	capitalize(java.lang.String s) Uppercases the first character of a string.
static java.lang.String	checkRequiredProperties(java.util.Properties props, java.lang.String... requiredProps) If any of the given list of properties are not found, returns the name of that property.
static java.lang.String	chomp(java.lang.Object o) Returns the result of calling toString() on the supplied Object, but with any trailing '\n' or '\r\n' removed.
static java.lang.String	chomp(java.lang.String s) Returns the supplied string with any trailing '\n' or '\r\n' removed.
static <T> T	columnStringToObject(java.lang.Class<?> objClass, java.lang.String str, java.util.regex.Pattern delimiterPattern, java.lang.String[] fieldNames) Converts a tab delimited string into an object with given fields Requires the object has public access for the specified fields
static <T> T	columnStringToObject(java.lang.Class objClass, java.lang.String str, java.lang.String delimiterRegex, java.lang.String[] fieldNames) Converts a tab delimited string into an object with given fields Requires the object has setXxx functions for the specified fields
static boolean	containsIgnoreCase(java.util.Collection<java.lang.String> c, java.lang.String s) Convenience method: a case-insensitive variant of Collection.contains.
static java.lang.String[]	decodeArray(java.lang.String encoded) Decode an array encoded as a String.
static java.util.Map<java.lang.String,java.lang.String>	decodeMap(java.lang.String encoded) Decode a map encoded as a string.
static int	editDistance(java.lang.String s, java.lang.String t) Computes the Levenshtein (edit) distance of the two given Strings.
static java.lang.String	escapeJsonString(java.lang.String str)
static java.lang.String	escapeString(java.lang.String s, char[] charsToEscape, char escapeChar)
static java.lang.String	expandEnvironmentVariables(java.lang.String raw) Takes an input String, and replaces any bash-style variables (e.g., $VAR_NAME) with its actual environment variable from System.getenv().
static java.lang.String	expandEnvironmentVariables(java.lang.String raw, java.util.Map<java.lang.String,java.lang.String> env) Takes an input String, and replaces any bash-style variables (e.g., $VAR_NAME) with its actual environment variable from the passed environment specification.
static java.lang.String	fileNameClean(java.lang.String s) Returns a "clean" version of the given filename in which spaces have been converted to dashes and all non-alphanumeric chars are underscores.
static boolean	find(java.lang.String str, java.lang.String regex) Say whether this regular expression can be found inside this String.
static java.lang.String	getBaseName(java.lang.String fileName) Strip directory from filename.
static java.lang.String	getBaseName(java.lang.String fileName, java.lang.String suffix) Strip directory and suffix from filename.
static java.lang.String	getBaseName(java.lang.String fileName, java.lang.String suffix, java.lang.String sep) Strip directory and suffix from the given name.
static java.util.Collection<java.lang.String>	getCharacterNgrams(java.lang.String s, int minSize, int maxSize) Build a list of character-based ngrams from the given string.
static java.util.Collection<java.lang.String>	getNgrams(java.util.List<java.lang.String> words, int minSize, int maxSize) n grams for already split string.
static java.util.Collection<java.lang.String>	getNgramsFromTokens(java.util.List<CoreLabel> words, int minSize, int maxSize) n grams for already split string.
static java.util.Collection<java.lang.String>	getNgramsString(java.lang.String s, int minSize, int maxSize) The string is split on whitespace and the ngrams are joined with a single space
static java.lang.String	getNotNullString(java.lang.String s)
static java.lang.String	getShortClassName(java.lang.Object o) Returns a short class name for an object.
static int	indexOfRegex(java.util.regex.Pattern pattern, java.lang.String s)
static int	indexOfRegex(java.util.regex.Pattern pattern, java.lang.String s, int index)
static boolean	isAcronym(java.lang.String s) Given a String the method uses Regex to check if the String looks like an acronym
static boolean	isAllUpperCase(java.lang.String s) Check if every non whitespace character is upper case (e.g.
static boolean	isAlpha(java.lang.String s) Given a String the method uses Regex to check if the String only contains alphabet characters
static boolean	isAlphanumeric(java.lang.String s) Given a String the method uses Regex to check if the String only contains alphanumeric characters
static boolean	isCapitalized(java.lang.String s) Check if a string begins with an uppercase.
static boolean	isNullOrEmpty(java.lang.String str) Returns whether a String is either null or empty.
static boolean	isNumeric(java.lang.String s) Given a String the method uses Regex to check if the String only contains numeric characters
static boolean	isPunct(java.lang.String s) Given a String the method uses Regex to check if the String only contains punctuation characters
static boolean	isTitleCase(java.lang.String s) Check if every word in a string begins with an uppercase and the rest is lower case (e.g.
static java.lang.String	join(java.lang.Iterable<?> l) Joins elements with a space.
static <X> java.lang.String	join(java.lang.Iterable<X> l, java.lang.String glue) Joins each elem in the Iterable with the given glue.
static <E> java.lang.String	join(java.util.List<? extends E> l, java.lang.String glue, java.util.function.Function<E,java.lang.String> toStringFunc, int start, int end)
static java.lang.String	join(java.lang.Object[] elements) Joins elements with a space.
static java.lang.String	join(java.lang.Object[] elements, int start, int end, java.lang.String glue) Joins an array of elements in a given span.
static java.lang.String	join(java.lang.Object[] elements, java.lang.String glue) Joins each elem in the array with the given glue.
static <X> java.lang.String	join(java.util.stream.Stream<X> l, java.lang.String glue) Joins each elem in the Stream with the given glue.
static java.lang.String	join(java.lang.String[] items, java.lang.String glue) Joins each element in the given array with the given glue.
static java.lang.String	joinFields(java.util.List<? extends CoreMap> l, java.lang.Class field)
static java.lang.String	joinFields(java.util.List<? extends CoreMap> l, java.lang.Class field, java.util.function.Function<java.lang.Object,java.lang.String> toStringFunc)
static java.lang.String	joinFields(java.util.List<? extends CoreMap> l, java.lang.Class field, java.lang.String defaultFieldValue, java.lang.String glue, int start, int end)
static java.lang.String	joinFields(java.util.List<? extends CoreMap> l, java.lang.Class field, java.lang.String defaultFieldValue, java.lang.String glue, int start, int end, java.util.function.Function<java.lang.Object,java.lang.String> toStringFunc)
static java.lang.String	joinMultipleFields(java.util.List<? extends CoreMap> l, java.lang.Class[] fields)
static java.lang.String	joinMultipleFields(java.util.List<? extends CoreMap> l, java.lang.Class[] fields, java.util.function.Function<java.lang.Object,java.lang.String> toStringFunc)
static java.lang.String	joinMultipleFields(java.util.List<? extends CoreMap> l, java.lang.Class[] fields, java.lang.String defaultFieldValue, java.lang.String fieldGlue, java.lang.String glue, int start, int end)
static java.lang.String	joinMultipleFields(java.util.List<? extends CoreMap> l, java.lang.Class[] fields, java.lang.String defaultFieldValue, java.lang.String fieldGlue, java.lang.String glue, int start, int end, java.util.function.Function<java.lang.Object,java.lang.String> toStringFunc)
static java.lang.String	joinWithOriginalWhiteSpace(java.util.List<CoreLabel> tokens) Joins all the tokens together (more or less) according to their original whitespace.
static java.lang.String	joinWords(java.lang.Iterable<? extends HasWord> l, java.lang.String glue)
static java.lang.String	joinWords(java.util.List<? extends HasWord> l, java.lang.String glue, int start, int end)
static <E> int	levenshteinDistance(E[] s1, E[] s2) I shamefully stole this from: http://rosettacode.org/wiki/Levenshtein_distance#Java --Gabor
static int	levenshteinDistance(java.lang.String s1, java.lang.String s2) I shamefully stole this from: http://rosettacode.org/wiki/Levenshtein_distance#Java --Gabor
static void	logInvocationString(Redwood.RedwoodChannels logger, java.lang.String[] args) Logs the command line arguments to Redwood on the given channels.
static int	longestCommonContiguousSubstring(java.lang.String s, java.lang.String t) Computes the longest common contiguous substring of s and t.
static int	longestCommonSubstring(java.lang.String s, java.lang.String t) Computes the longest common substring of s and t.
static boolean	lookingAt(java.lang.String str, java.lang.String regex) Say whether this regular expression can be found at the beginning of this String.
static void	main(java.lang.String[] args) Tests the string edit distance function.
static java.lang.String	makeHTMLTable(java.lang.String[][] table, java.lang.String[] rowLabels, java.lang.String[] colLabels) Returns an HTML table containing the matrix of Strings passed in.
static java.lang.String	makeTextTable(java.lang.Object[][] table, java.lang.Object[] rowLabels, java.lang.Object[] colLabels, int padLeft, int padRight, boolean tsv) Returns a text table containing the matrix of objects passed in.
static java.lang.String[]	mapStringToArray(java.lang.String map) Takes a string of the form "x1=y1,x2=y2,..." such that each y is an integer and each x is a key.
static java.util.Map<java.lang.String,java.lang.String>	mapStringToMap(java.lang.String map) Takes a string of the form "x1=y1,x2=y2,..." and returns Map.
static boolean	matches(java.lang.String str, java.lang.String regex) Say whether this regular expression matches this String.
static java.lang.String	normalize(java.lang.String s)
static int	nthIndex(java.lang.String s, char ch, int n) Returns the index of the nth occurrence of ch in s, or -1 if there are less than n occurrences of ch.
static java.lang.String	objectToColumnString(java.lang.Object object, java.lang.String delimiter, java.lang.String[] fieldNames) Converts an object into a tab delimited string with given fields Requires the object has public access for the specified fields
static java.lang.String	pad(java.lang.Object obj, int totalChars) Pads the toString value of the given Object.
static java.lang.String	pad(java.lang.String str, int totalChars) Return a String of length a minimum of totalChars characters by padding the input String str at the right end with spaces.
static java.lang.String	pad(java.lang.String str, int totalChars, char pad) Return a String of length a minimum of totalChars characters by padding the input String str at the right end with spaces.
static java.lang.String	padLeft(double d, int totalChars)
static java.lang.String	padLeft(int i, int totalChars)
static java.lang.String	padLeft(java.lang.Object obj, int totalChars)
static java.lang.String	padLeft(java.lang.String str, int totalChars) Pads the given String to the left with spaces to ensure that it's at least totalChars long.
static java.lang.String	padLeft(java.lang.String str, int totalChars, char ch) Pads the given String to the left with the given character ch to ensure that it's at least totalChars long.
static java.lang.String	padLeftOrTrim(java.lang.String str, int num) Pad or trim so as to produce a string of exactly a certain length.
static java.lang.String	padOrTrim(java.lang.Object obj, int totalChars) Pad or trim the toString value of the given Object.
static java.lang.String	padOrTrim(java.lang.String str, int num) Pad or trim so as to produce a string of exactly a certain length.
static java.util.Map<java.lang.String,java.lang.String>	parseCommandLineArguments(java.lang.String[] args) A simpler form of command line argument parsing.
static java.util.Map<java.lang.String,java.lang.Object>	parseCommandLineArguments(java.lang.String[] args, boolean parseNumbers) A simpler form of command line argument parsing.
static java.lang.String	pennPOSToWordnetPOS(java.lang.String s) Computes the WordNet 2.0 POS tag corresponding to the PTB POS tag s.
static void	printStringOneCharPerLine(java.lang.String s)
static void	printToFile(java.io.File file, java.lang.String message) Prints to a file.
static void	printToFile(java.io.File file, java.lang.String message, boolean append) Prints to a file.
static void	printToFile(java.io.File file, java.lang.String message, boolean append, boolean printLn, java.lang.String encoding) Prints to a file.
static void	printToFile(java.lang.String filename, java.lang.String message) Prints to a file.
static void	printToFile(java.lang.String filename, java.lang.String message, boolean append) Prints to a file.
static void	printToFileLn(java.io.File file, java.lang.String message, boolean append) Prints to a file.
static void	printToFileLn(java.lang.String filename, java.lang.String message, boolean append) Prints to a file.
static java.util.LinkedHashMap<java.lang.String,java.lang.String>	propFileToLinkedHashMap(java.lang.String filename, java.util.Map<java.lang.String,java.lang.String> existingArgs) This method reads in properties listed in a file in the format prop=value, one property per line.
static java.util.Properties	propFileToProperties(java.lang.String filename) This method reads in properties listed in a file in the format prop=value, one property per line.
static java.util.List<java.util.regex.Pattern>	regexesToPatterns(java.lang.Iterable<java.lang.String> regexes)
static java.util.List<java.lang.String>	regexGroups(java.util.regex.Pattern regex, java.lang.String str) Given a pattern, which contains one or more capturing groups, and a String, returns a list with the values of the captured groups in the pattern.
static java.lang.String	repeat(char ch, int times)
static java.lang.String	repeat(java.lang.String s, int times)
static java.lang.String	resolveVars(java.lang.String str, java.util.Map props) Resolve variable.
static java.lang.String	searchAndReplace(java.lang.String text, java.lang.String from, java.lang.String to)
static java.util.List<java.lang.String>	split(java.lang.String s) Splits on whitespace (\\s+).
static java.util.List<java.lang.String>	split(java.lang.String str, java.lang.String regex) Splits the given string using the given regex as delimiters.
static java.util.List<java.util.List<java.lang.String>>	splitFieldsFast(java.lang.String str, java.lang.String delimiter) Splits a string into whitespace tokenized fields based on a delimiter and then whitespace.
static java.util.List<java.lang.String>	splitKeepDelimiter(java.lang.String s, java.lang.String separator) Splits on the given delimiter and returns the delimiters as well.
static java.util.List<java.lang.String>	splitLinesKeepNewlines(java.lang.String s) Split the text into pieces based on newlines.
static void	splitOnChar(java.lang.String[] out, java.lang.String input, char delimiter) Split on a given character, filling out the fields in the output array.
static java.lang.String[]	splitOnChar(java.lang.String input, char delimiter) Split a string on a given single character.
static java.lang.String[]	splitOnCharWithQuoting(java.lang.String s, char splitChar, char quoteChar, char escapeChar) This function splits the String s into multiple Strings using the splitChar.
static java.util.Properties	stringToProperties(java.lang.String str) This method converts a comma-separated String (with whitespace optionally allowed after the comma) representing properties to a Properties object.
static java.util.Properties	stringToProperties(java.lang.String str, java.util.Properties props) This method updates a Properties object based on a comma-separated String (with whitespace optionally allowed after the comma) representing properties to a Properties object.
static java.util.LinkedHashMap<java.lang.String,java.lang.String>	stringToPropertiesMap(java.lang.String str) This method updates a LinkedHashMap based on a comma-separated String (with whitespace optionally allowed after the comma) representing properties to a Properties object.
static java.util.Set<java.lang.String>	stringToSet(java.lang.String str, java.lang.String delimiter)
static java.lang.String	stripNonAlphaNumerics(java.lang.String orig)
static java.lang.String	stripSGML(java.lang.String orig)
static java.lang.String	toAscii(java.lang.String s)
static java.lang.String	toCSVString(java.lang.String[] fields)
static java.lang.String	toString(CoreMap sentence) Convert a CoreMap representing a sentence into a string, by simply joining them with spaces.
static java.lang.String	toString(java.util.List<CoreLabel> words) Convert a list of labels into a string, by simply joining them with spaces.
static java.lang.String	toTitleCase(java.lang.String s)
static java.lang.String	tr(java.lang.String input, java.lang.String from, java.lang.String to) Swap any occurrences of any characters in the from String in the input String with the corresponding character from the to String.
static java.lang.String	trim(java.lang.Object obj, int maxWidth)
static java.lang.String	trim(java.lang.String s, int maxWidth) Returns s if it's at most maxWidth chars, otherwise chops right side to fit.
static java.lang.String	trimWithEllipsis(java.lang.Object o, int width)
static java.lang.String	trimWithEllipsis(java.lang.String s, int width)
static java.lang.String	truncate(int n, int smallestDigit, int biggestDigit) This returns a string from decimal digit smallestDigit to decimal digit biggest digit.
static java.lang.String	unescapeHtml3(java.lang.String input) Unescape an HTML string.
static java.util.List<java.lang.String>	valueSplit(java.lang.String str, java.lang.String valueRegex, java.lang.String separatorRegex) Split a string into tokens.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STRING_ARRAY

public static final java.lang.String[] EMPTY_STRING_ARRAY

Method Detail

find

public static boolean find(java.lang.String str,
                           java.lang.String regex)

Say whether this regular expression can be found inside this String. This method provides one of the two "missing" convenience methods for regular expressions in the String class in JDK1.4. This is the one you'll want to use all the time if you're used to Perl. What were they smoking?

Parameters:

str - String to search for match in

regex - String to compile as the regular expression

Returns:

Whether the regex can be found in str

containsIgnoreCase

public static boolean containsIgnoreCase(java.util.Collection<java.lang.String> c,
                                         java.lang.String s)

Convenience method: a case-insensitive variant of Collection.contains.

Parameters:

c - Collection<String>

s - String

Returns:

true if s case-insensitively matches a string in c

lookingAt

public static boolean lookingAt(java.lang.String str,
                                java.lang.String regex)

Say whether this regular expression can be found at the beginning of this String. This method provides one of the two "missing" convenience methods for regular expressions in the String class in JDK1.4.

Parameters:

str - String to search for match at start of

regex - String to compile as the regular expression

Returns:

Whether the regex can be found at the start of str

mapStringToArray

public static java.lang.String[] mapStringToArray(java.lang.String map)

Takes a string of the form "x1=y1,x2=y2,..." such that each y is an integer and each x is a key. A String[] s is returned such that s[yn]=xn.

Parameters:

map - A string of the form "x1=y1,x2=y2,..." such that each y is an integer and each x is a key.

Returns:

A String[] s is returned such that s[yn]=xn

mapStringToMap

public static java.util.Map<java.lang.String,java.lang.String> mapStringToMap(java.lang.String map)

Takes a string of the form "x1=y1,x2=y2,..." and returns Map.

Parameters:

map - A string of the form "x1=y1,x2=y2,..."

Returns:

A Map m is returned such that m.get(xn) = yn

regexesToPatterns

public static java.util.List<java.util.regex.Pattern> regexesToPatterns(java.lang.Iterable<java.lang.String> regexes)

regexGroups

public static java.util.List<java.lang.String> regexGroups(java.util.regex.Pattern regex,
                                                           java.lang.String str)

Given a pattern, which contains one or more capturing groups, and a String, returns a list with the values of the captured groups in the pattern. If the pattern does not match, returns null. Note that this uses Matcher.find() rather than Matcher.matches(). If str is null, returns null.

matches

public static boolean matches(java.lang.String str,
                              java.lang.String regex)

Say whether this regular expression matches this String. This method is the same as the String.matches() method, and is included just to give a call that is parallel to the other static regex methods in this class.

Parameters:

str - String to search for match at start of

regex - String to compile as the regular expression

Returns:

Whether the regex matches the whole of this str

stringToSet

public static java.util.Set<java.lang.String> stringToSet(java.lang.String str,
                                                          java.lang.String delimiter)

joinWords

public static java.lang.String joinWords(java.lang.Iterable<? extends HasWord> l,
                                         java.lang.String glue)

join

public static <E> java.lang.String join(java.util.List<? extends E> l,
                                        java.lang.String glue,
                                        java.util.function.Function<E,java.lang.String> toStringFunc,
                                        int start,
                                        int end)

joinWords

public static java.lang.String joinWords(java.util.List<? extends HasWord> l,
                                         java.lang.String glue,
                                         int start,
                                         int end)

joinFields

public static java.lang.String joinFields(java.util.List<? extends CoreMap> l,
                                          java.lang.Class field,
                                          java.lang.String defaultFieldValue,
                                          java.lang.String glue,
                                          int start,
                                          int end,
                                          java.util.function.Function<java.lang.Object,java.lang.String> toStringFunc)

joinFields

public static java.lang.String joinFields(java.util.List<? extends CoreMap> l,
                                          java.lang.Class field,
                                          java.lang.String defaultFieldValue,
                                          java.lang.String glue,
                                          int start,
                                          int end)

joinFields

public static java.lang.String joinFields(java.util.List<? extends CoreMap> l,
                                          java.lang.Class field,
                                          java.util.function.Function<java.lang.Object,java.lang.String> toStringFunc)

joinFields

public static java.lang.String joinFields(java.util.List<? extends CoreMap> l,
                                          java.lang.Class field)

joinMultipleFields

public static java.lang.String joinMultipleFields(java.util.List<? extends CoreMap> l,
                                                  java.lang.Class[] fields,
                                                  java.lang.String defaultFieldValue,
                                                  java.lang.String fieldGlue,
                                                  java.lang.String glue,
                                                  int start,
                                                  int end,
                                                  java.util.function.Function<java.lang.Object,java.lang.String> toStringFunc)

joinMultipleFields

public static java.lang.String joinMultipleFields(java.util.List<? extends CoreMap> l,
                                                  java.lang.Class[] fields,
                                                  java.util.function.Function<java.lang.Object,java.lang.String> toStringFunc)

joinMultipleFields

public static java.lang.String joinMultipleFields(java.util.List<? extends CoreMap> l,
                                                  java.lang.Class[] fields,
                                                  java.lang.String defaultFieldValue,
                                                  java.lang.String fieldGlue,
                                                  java.lang.String glue,
                                                  int start,
                                                  int end)

joinMultipleFields

public static java.lang.String joinMultipleFields(java.util.List<? extends CoreMap> l,
                                                  java.lang.Class[] fields)

joinWithOriginalWhiteSpace

public static java.lang.String joinWithOriginalWhiteSpace(java.util.List<CoreLabel> tokens)

Joins all the tokens together (more or less) according to their original whitespace. It assumes all whitespace was " ".

Parameters:

tokens - list of tokens which implement HasOffset and HasWord

Returns:

a string of the tokens with the appropriate amount of spacing

join

public static <X> java.lang.String join(java.lang.Iterable<X> l,
                                        java.lang.String glue)

Joins each elem in the Iterable with the given glue. For example, given a list of Integers, you can create a comma-separated list by calling join(numbers, ", ").

See Also:

join(Stream, String)

join

public static <X> java.lang.String join(java.util.stream.Stream<X> l,
                                        java.lang.String glue)

Joins each elem in the Stream with the given glue. For example, given a list of Integers, you can create a comma-separated list by calling join(numbers, ", ").

See Also:

join(Iterable, String)

join

public static java.lang.String join(java.lang.Object[] elements,
                                    java.lang.String glue)

Joins each elem in the array with the given glue. For example, given a list of ints, you can create a comma-separated list by calling join(numbers, ", ").

join

public static java.lang.String join(java.lang.Object[] elements,
                                    int start,
                                    int end,
                                    java.lang.String glue)

Joins an array of elements in a given span.

Parameters:

elements - The elements to join.

start - The start index to join from.

end - The end (non-inclusive) to join until.

glue - The glue to hold together the elements.

Returns:

The string form of the sub-array, joined on the given glue.

join

public static java.lang.String join(java.lang.String[] items,
                                    java.lang.String glue)

Joins each element in the given array with the given glue. For example, given an array of Integers, you can create a comma-separated list by calling join(numbers, ", ").

join

public static java.lang.String join(java.lang.Iterable<?> l)

Joins elements with a space.

join

public static java.lang.String join(java.lang.Object[] elements)

Joins elements with a space.

split

public static java.util.List<java.lang.String> split(java.lang.String s)

Splits on whitespace (\\s+).
Note that this follows Java split style, meaning leading spaces will result in an empty string and trailing spaces will be cut off.

Parameters:

s - String to split

Returns:

List of split strings

splitKeepDelimiter

public static java.util.List<java.lang.String> splitKeepDelimiter(java.lang.String s,
                                                                  java.lang.String separator)

Splits on the given delimiter and returns the delimiters as well.
For expressions where the expression appears inside itself this may not work.
See http://stackoverflow.com/a/2206432

Parameters:

s - String to split

separator - Delimiter to use for splitting

Returns:

List of split strings

splitLinesKeepNewlines

public static java.util.List<java.lang.String> splitLinesKeepNewlines(java.lang.String s)

Split the text into pieces based on newlines. Include the newline tokens in the pieces.

Parameters:

s - String to splits

split

public static java.util.List<java.lang.String> split(java.lang.String str,
                                                     java.lang.String regex)

Splits the given string using the given regex as delimiters. This method is the same as the String.split() method (except it throws the results in a List), and is included just to give a call that is parallel to the other static regex methods in this class.

Parameters:

str - String to split up

regex - String to compile as the regular expression

Returns:

List of Strings resulting from splitting on the regex

splitOnChar

public static java.lang.String[] splitOnChar(java.lang.String input,
                                             char delimiter)

Split a string on a given single character. This method is often faster than the regular split() method.

Parameters:

input - The input to split.

delimiter - The character to split on.

Returns:

An array of Strings corresponding to the original input split on the delimiter character.

splitFieldsFast

public static java.util.List<java.util.List<java.lang.String>> splitFieldsFast(java.lang.String str,
                                                                               java.lang.String delimiter)

Splits a string into whitespace tokenized fields based on a delimiter and then whitespace. For example, "aa bb | bb cc | ccc ddd" would be split into "[aa,bb],[bb,cc],[ccc,ddd]" based on the delimiter "|". This method uses the old StringTokenizer class, which is up to 3x faster than the regex-based "split()" methods.

Parameters:

delimiter - String to split on

Returns:

List of lists of strings.

splitOnChar

public static void splitOnChar(java.lang.String[] out,
                               java.lang.String input,
                               char delimiter)

Split on a given character, filling out the fields in the output array. This is suitable for, e.g., splitting a TSV file of known column count.

Parameters:

out - The output array to fill

input - The input to split

delimiter - The delimiter to split on.

valueSplit

public static java.util.List<java.lang.String> valueSplit(java.lang.String str,
                                                          java.lang.String valueRegex,
                                                          java.lang.String separatorRegex)

Split a string into tokens. Because there is a tokenRegex as well as a separatorRegex (unlike for the conventional split), you can do things like correctly split quoted strings or parenthesized arguments. However, it doesn't do the unquoting of quoted Strings for you. An empty String argument is returned at the beginning, if valueRegex accepts the empty String and str begins with separatorRegex. But str can end with either valueRegex or separatorRegex and this does not generate an empty String at the end (indeed, valueRegex need not even accept the empty String in this case. However, if it does accept the empty String and there are multiple trailing separators, then empty values will be returned.

Parameters:

str - The String to split

valueRegex - Must match a token. You may wish to let it match the empty String

separatorRegex - Must match a separator

Returns:

The List of tokens

Throws:

java.lang.IllegalArgumentException - if str cannot be tokenized by the two regex

pad

public static java.lang.String pad(java.lang.String str,
                                   int totalChars)

Return a String of length a minimum of totalChars characters by padding the input String str at the right end with spaces. If str is already longer than totalChars, it is returned unchanged.

pad

public static java.lang.String pad(java.lang.String str,
                                   int totalChars,
                                   char pad)

Return a String of length a minimum of totalChars characters by padding the input String str at the right end with spaces. If str is already longer than totalChars, it is returned unchanged.

pad

public static java.lang.String pad(java.lang.Object obj,
                                   int totalChars)

Pads the toString value of the given Object.

padOrTrim

public static java.lang.String padOrTrim(java.lang.String str,
                                         int num)

Pad or trim so as to produce a string of exactly a certain length.

Parameters:

str - The String to be padded or truncated

num - The desired length

padLeftOrTrim

public static java.lang.String padLeftOrTrim(java.lang.String str,
                                             int num)

Pad or trim so as to produce a string of exactly a certain length.

Parameters:

str - The String to be padded or truncated

num - The desired length

padOrTrim

public static java.lang.String padOrTrim(java.lang.Object obj,
                                         int totalChars)

Pad or trim the toString value of the given Object.

padLeft

public static java.lang.String padLeft(java.lang.String str,
                                       int totalChars,
                                       char ch)

Pads the given String to the left with the given character ch to ensure that it's at least totalChars long.

padLeft

public static java.lang.String padLeft(java.lang.String str,
                                       int totalChars)

Pads the given String to the left with spaces to ensure that it's at least totalChars long.

padLeft

public static java.lang.String padLeft(java.lang.Object obj,
                                       int totalChars)

padLeft

public static java.lang.String padLeft(int i,
                                       int totalChars)

padLeft

public static java.lang.String padLeft(double d,
                                       int totalChars)

trim

public static java.lang.String trim(java.lang.String s,
                                    int maxWidth)

Returns s if it's at most maxWidth chars, otherwise chops right side to fit.

trim

public static java.lang.String trim(java.lang.Object obj,
                                    int maxWidth)

trimWithEllipsis

public static java.lang.String trimWithEllipsis(java.lang.String s,
                                                int width)

trimWithEllipsis

public static java.lang.String trimWithEllipsis(java.lang.Object o,
                                                int width)

repeat

public static java.lang.String repeat(java.lang.String s,
                                      int times)

repeat

public static java.lang.String repeat(char ch,
                                      int times)

fileNameClean

public static java.lang.String fileNameClean(java.lang.String s)

Returns a "clean" version of the given filename in which spaces have been converted to dashes and all non-alphanumeric chars are underscores.

nthIndex

public static int nthIndex(java.lang.String s,
                           char ch,
                           int n)

Returns the index of the nth occurrence of ch in s, or -1 if there are less than n occurrences of ch.

truncate

public static java.lang.String truncate(int n,
                                        int smallestDigit,
                                        int biggestDigit)

This returns a string from decimal digit smallestDigit to decimal digit biggest digit. Smallest digit is labeled 1, and the limits are inclusive.

argsToMap

public static java.util.Map<java.lang.String,java.lang.String[]> argsToMap(java.lang.String[] args)

Parses command line arguments into a Map. Arguments of the form
-flag1 arg1a arg1b ... arg1m -flag2 -flag3 arg3a ... arg3n
will be parsed so that the flag is a key in the Map (including the hyphen) and its value will be a String[] containing the optional arguments (if present). The non-flag values not captured as flag arguments are collected into a String[] array and returned as the value of null in the Map. In this invocation, flags cannot take arguments, so all the String array values other than the value for null will be zero-length.

Parameters:

args - A command-line arguments array

Returns:

a Map of flag names to flag argument String arrays.

argsToMap

public static java.util.Map<java.lang.String,java.lang.String[]> argsToMap(java.lang.String[] args,
                                                                           java.util.Map<java.lang.String,java.lang.Integer> flagsToNumArgs)

Parses command line arguments into a Map. Arguments of the form
-flag1 arg1a arg1b ... arg1m -flag2 -flag3 arg3a ... arg3n
will be parsed so that the flag is a key in the Map (including the hyphen) and its value will be a String[] containing the optional arguments (if present). The non-flag values not captured as flag arguments are collected into a String[] array and returned as the value of null in the Map. In this invocation, the maximum number of arguments for each flag can be specified as an Integer value of the appropriate flag key in the flagsToNumArgs Map argument. (By default, flags cannot take arguments.)
Example of usage:
Map flagsToNumArgs = new HashMap(); flagsToNumArgs.put("-x",new Integer(2)); flagsToNumArgs.put("-d",new Integer(1)); Map result = argsToMap(args,flagsToNumArgs);
If a given flag appears more than once, the extra args are appended to the String[] value for that flag.

Parameters:

args - the argument array to be parsed

flagsToNumArgs - a Map of flag names to Integer values specifying the number of arguments for that flag (default min 0, max 1).

Returns:

a Map of flag names to flag argument String

argsToProperties

public static java.util.Properties argsToProperties(java.lang.String... args)

In this version each flag has zero or one argument. It has one argument if there is a thing following a flag that does not begin with '-'. See argsToProperties(String[], Map) for full documentation.

Parameters:

args - Command line arguments

Returns:

A Properties object representing the arguments.

argsToProperties

public static java.util.Properties argsToProperties(java.lang.String[] args,
                                                    java.util.Map<java.lang.String,java.lang.Integer> flagsToNumArgs)

Analogous to argsToMap(java.lang.String[]). However, there are several key differences between this method and argsToMap(java.lang.String[]):

• Hyphens are stripped from flag names
• Since Properties objects are String to String mappings, the default number of arguments to a flag is assumed to be 1 and not 0.
• Furthermore, the list of arguments not bound to a flag is mapped to the "" property, not null
• The special flags "-prop", "-props", "-properties", "-args", or "-arguments" will load the property file specified by its argument.
• The value for flags without arguments is set to "true"
• If a flag has multiple arguments, the value of the property is all of the arguments joined together with a space (" ") character between them.
• The value strings are trimmed so trailing spaces do not stop you from loading a file.

Properties are read from left to right, and later properties will override earlier ones with the same name. Properties loaded from a Properties file with the special args are defaults that can be overridden by command line flags (or earlier Properties files if there is nested usage of the special args.

Parameters:

args - Command line arguments

flagsToNumArgs - Map of how many arguments flags should have. The keys are without the minus signs.

Returns:

A Properties object representing the arguments.

propFileToProperties

public static java.util.Properties propFileToProperties(java.lang.String filename)

This method reads in properties listed in a file in the format prop=value, one property per line. Although Properties.load(InputStream) exists, I implemented this method to trim the lines, something not implemented in the load() method.

Parameters:

filename - A properties file to read

Returns:

The corresponding Properties object

stringToProperties

public static java.util.Properties stringToProperties(java.lang.String str)

This method converts a comma-separated String (with whitespace optionally allowed after the comma) representing properties to a Properties object. Each property is "property=value". The value for properties without an explicitly given value is set to "true". This can be used for a 2nd level of properties, for example, when you have a commandline argument like "-outputOptions style=xml,tags".

stringToProperties

public static java.util.Properties stringToProperties(java.lang.String str,
                                                      java.util.Properties props)

This method updates a Properties object based on a comma-separated String (with whitespace optionally allowed after the comma) representing properties to a Properties object. Each property is "property=value". The value for properties without an explicitly given value is set to "true".

stringToPropertiesMap

public static java.util.LinkedHashMap<java.lang.String,java.lang.String> stringToPropertiesMap(java.lang.String str)

This method updates a LinkedHashMap based on a comma-separated String (with whitespace optionally allowed after the comma) representing properties to a Properties object. Each property is "property=value". The value for properties without an explicitly given value is set to "true". TODO: remove the stringToProperties version

checkRequiredProperties

public static java.lang.String checkRequiredProperties(java.util.Properties props,
                                                       java.lang.String... requiredProps)

If any of the given list of properties are not found, returns the name of that property. Otherwise, returns null.

printToFile

public static void printToFile(java.io.File file,
                               java.lang.String message,
                               boolean append,
                               boolean printLn,
                               java.lang.String encoding)

Prints to a file. If the file already exists, appends if append=true, and overwrites if append=false.

printToFileLn

public static void printToFileLn(java.io.File file,
                                 java.lang.String message,
                                 boolean append)

Prints to a file. If the file already exists, appends if append=true, and overwrites if append=false.

printToFile

public static void printToFile(java.io.File file,
                               java.lang.String message,
                               boolean append)

Prints to a file. If the file already exists, appends if append=true, and overwrites if append=false.

printToFile

public static void printToFile(java.io.File file,
                               java.lang.String message)

Prints to a file. If the file does not exist, rewrites the file; does not append.

printToFile

public static void printToFile(java.lang.String filename,
                               java.lang.String message,
                               boolean append)

Prints to a file. If the file already exists, appends if append=true, and overwrites if append=false.

printToFileLn

public static void printToFileLn(java.lang.String filename,
                                 java.lang.String message,
                                 boolean append)

Prints to a file. If the file already exists, appends if append=true, and overwrites if append=false.

printToFile

public static void printToFile(java.lang.String filename,
                               java.lang.String message)

Prints to a file. If the file does not exist, rewrites the file; does not append.

parseCommandLineArguments

public static java.util.Map<java.lang.String,java.lang.String> parseCommandLineArguments(java.lang.String[] args)

A simpler form of command line argument parsing. Dan thinks this is highly superior to the overly complexified code that comes before it. Parses command line arguments into a Map. Arguments of the form -flag1 arg1 -flag2 -flag3 arg3 will be parsed so that the flag is a key in the Map (including the hyphen) and the optional argument will be its value (if present).

Returns:

A Map from keys to possible values (String or null)

parseCommandLineArguments

public static java.util.Map<java.lang.String,java.lang.Object> parseCommandLineArguments(java.lang.String[] args,
                                                                                         boolean parseNumbers)

A simpler form of command line argument parsing. Dan thinks this is highly superior to the overly complexified code that comes before it. Parses command line arguments into a Map. Arguments of the form -flag1 arg1 -flag2 -flag3 arg3 will be parsed so that the flag is a key in the Map (including the hyphen) and the optional argument will be its value (if present). In this version, if the argument is numeric, it will be a Double value in the map, not a String.

Returns:

A Map from keys to possible values (String or null)

stripNonAlphaNumerics

public static java.lang.String stripNonAlphaNumerics(java.lang.String orig)

stripSGML

public static java.lang.String stripSGML(java.lang.String orig)

printStringOneCharPerLine

public static void printStringOneCharPerLine(java.lang.String s)

escapeString

public static java.lang.String escapeString(java.lang.String s,
                                            char[] charsToEscape,
                                            char escapeChar)

splitOnCharWithQuoting

public static java.lang.String[] splitOnCharWithQuoting(java.lang.String s,
                                                        char splitChar,
                                                        char quoteChar,
                                                        char escapeChar)

This function splits the String s into multiple Strings using the splitChar. However, it provides a quoting facility: it is possible to quote strings with the quoteChar. If the quoteChar occurs within the quotedExpression, it must be prefaced by the escapeChar. This routine can be useful for processing a line of a CSV file.

Parameters:

s - The String to split into fields. Cannot be null.

splitChar - The character to split on

quoteChar - The character to quote items with

escapeChar - The character to escape the quoteChar with

Returns:

An array of Strings that s is split into

longestCommonSubstring

public static int longestCommonSubstring(java.lang.String s,
                                         java.lang.String t)

Computes the longest common substring of s and t. The longest common substring of a and b is the longest run of characters that appear in order inside both a and b. Both a and b may have other extraneous characters along the way. This is like edit distance but with no substitution and a higher number means more similar. For example, the LCS of "abcD" and "aXbc" is 3 (abc).

longestCommonContiguousSubstring

public static int longestCommonContiguousSubstring(java.lang.String s,
                                                   java.lang.String t)

Computes the longest common contiguous substring of s and t. The LCCS is the longest run of characters that appear consecutively in both s and t. For instance, the LCCS of "color" and "colour" is 4, because of "colo".

editDistance

public static int editDistance(java.lang.String s,
                               java.lang.String t)

Computes the Levenshtein (edit) distance of the two given Strings. This method doesn't allow transposition, so one character transposed between two strings has a cost of 2 (one insertion, one deletion). The EditDistance class also implements the Levenshtein distance, but does allow transposition.

pennPOSToWordnetPOS

public static java.lang.String pennPOSToWordnetPOS(java.lang.String s)

Computes the WordNet 2.0 POS tag corresponding to the PTB POS tag s.

Parameters:

s - a Penn TreeBank POS tag.

getShortClassName

public static java.lang.String getShortClassName(java.lang.Object o)

Returns a short class name for an object. This is the class name stripped of any package name.

Returns:

The name of the class minus a package name, for example ArrayList

columnStringToObject

public static <T> T columnStringToObject(java.lang.Class objClass,
                                         java.lang.String str,
                                         java.lang.String delimiterRegex,
                                         java.lang.String[] fieldNames)
                                  throws java.lang.InstantiationException,
                                         java.lang.IllegalAccessException,
                                         java.lang.NoSuchFieldException,
                                         java.lang.NoSuchMethodException,
                                         java.lang.reflect.InvocationTargetException

Converts a tab delimited string into an object with given fields Requires the object has setXxx functions for the specified fields

Type Parameters:

T - type to return

Parameters:

objClass - Class of object to be created

str - string to convert

delimiterRegex - delimiter regular expression

fieldNames - fieldnames

Returns:

Object created from string

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.NoSuchFieldException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

columnStringToObject

public static <T> T columnStringToObject(java.lang.Class<?> objClass,
                                         java.lang.String str,
                                         java.util.regex.Pattern delimiterPattern,
                                         java.lang.String[] fieldNames)
                                  throws java.lang.InstantiationException,
                                         java.lang.IllegalAccessException,
                                         java.lang.NoSuchMethodException,
                                         java.lang.NoSuchFieldException,
                                         java.lang.reflect.InvocationTargetException

Converts a tab delimited string into an object with given fields Requires the object has public access for the specified fields

Type Parameters:

T - type to return

Parameters:

objClass - Class of object to be created

str - string to convert

delimiterPattern - delimiter

fieldNames - fieldnames

Returns:

Object created from string

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.NoSuchMethodException

java.lang.NoSuchFieldException

java.lang.reflect.InvocationTargetException

objectToColumnString

public static java.lang.String objectToColumnString(java.lang.Object object,
                                                    java.lang.String delimiter,
                                                    java.lang.String[] fieldNames)
                                             throws java.lang.IllegalAccessException,
                                                    java.lang.NoSuchFieldException,
                                                    java.lang.NoSuchMethodException,
                                                    java.lang.reflect.InvocationTargetException

Converts an object into a tab delimited string with given fields Requires the object has public access for the specified fields

Parameters:

object - Object to convert

delimiter - delimiter

fieldNames - fieldnames

Returns:

String representing object

Throws:

java.lang.IllegalAccessException

java.lang.NoSuchFieldException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

capitalize

public static java.lang.String capitalize(java.lang.String s)

Uppercases the first character of a string.

Parameters:

s - a string to capitalize

Returns:

a capitalized version of the string

isCapitalized

public static boolean isCapitalized(java.lang.String s)

Check if a string begins with an uppercase.

Parameters:

s - a string

Returns:

true if the string is capitalized false otherwise

toTitleCase

public static java.lang.String toTitleCase(java.lang.String s)

isTitleCase

public static boolean isTitleCase(java.lang.String s)

Check if every word in a string begins with an uppercase and the rest is lower case (e.g. Title Case)

Parameters:

s - a string

Returns:

true if the string is Title case false otherwise

isAllUpperCase

public static boolean isAllUpperCase(java.lang.String s)

Check if every non whitespace character is upper case (e.g. TITLE CASE)

Parameters:

s - a string

Returns:

true if the string is Title case false otherwise

searchAndReplace

public static java.lang.String searchAndReplace(java.lang.String text,
                                                java.lang.String from,
                                                java.lang.String to)

makeHTMLTable

public static java.lang.String makeHTMLTable(java.lang.String[][] table,
                                             java.lang.String[] rowLabels,
                                             java.lang.String[] colLabels)

Returns an HTML table containing the matrix of Strings passed in. The first dimension of the matrix should represent the rows, and the second dimension the columns.

makeTextTable

public static java.lang.String makeTextTable(java.lang.Object[][] table,
                                             java.lang.Object[] rowLabels,
                                             java.lang.Object[] colLabels,
                                             int padLeft,
                                             int padRight,
                                             boolean tsv)

Returns a text table containing the matrix of objects passed in. The first dimension of the matrix should represent the rows, and the second dimension the columns. Each object is printed in a cell with toString(). The printing may be padded with spaces on the left and then on the right to ensure that the String form is of length at least padLeft or padRight. If tsv is true, a tab is put between columns.

Returns:

A String form of the table

main

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

Tests the string edit distance function.

toAscii

public static java.lang.String toAscii(java.lang.String s)

toCSVString

public static java.lang.String toCSVString(java.lang.String[] fields)

tr

public static java.lang.String tr(java.lang.String input,
                                  java.lang.String from,
                                  java.lang.String to)

Swap any occurrences of any characters in the from String in the input String with the corresponding character from the to String. As Perl tr, for example, tr("chris", "irs", "mop").equals("chomp"), except it does not support regular expression character ranges.

Note: This is now optimized to not allocate any objects if the input is returned unchanged.

chomp

public static java.lang.String chomp(java.lang.String s)

Returns the supplied string with any trailing '\n' or '\r\n' removed.

chomp

public static java.lang.String chomp(java.lang.Object o)

Returns the result of calling toString() on the supplied Object, but with any trailing '\n' or '\r\n' removed.

getBaseName

public static java.lang.String getBaseName(java.lang.String fileName)

Strip directory from filename. Like Unix 'basename'.
Example: getBaseName("/u/wcmac/foo.txt") ==> "foo.txt"

getBaseName

public static java.lang.String getBaseName(java.lang.String fileName,
                                           java.lang.String suffix)

Strip directory and suffix from filename. Like Unix 'basename'. Example: getBaseName("/u/wcmac/foo.txt", "") ==> "foo.txt"
Example: getBaseName("/u/wcmac/foo.txt", ".txt") ==> "foo"
Example: getBaseName("/u/wcmac/foo.txt", ".pdf") ==> "foo.txt"

getBaseName

public static java.lang.String getBaseName(java.lang.String fileName,
                                           java.lang.String suffix,
                                           java.lang.String sep)

Strip directory and suffix from the given name. Like Unix 'basename'. Example: getBaseName("/tmp/foo/bar/foo", "", "/") ==> "foo"
Example: getBaseName("edu.stanford.nlp", "", "\\.") ==> "nlp"

isAlpha

public static boolean isAlpha(java.lang.String s)

Given a String the method uses Regex to check if the String only contains alphabet characters

Parameters:

s - a String to check using regex

Returns:

true if the String is valid

isNumeric

public static boolean isNumeric(java.lang.String s)

Given a String the method uses Regex to check if the String only contains numeric characters

Parameters:

s - a String to check using regex

Returns:

true if the String is valid

isAlphanumeric

public static boolean isAlphanumeric(java.lang.String s)

Given a String the method uses Regex to check if the String only contains alphanumeric characters

Parameters:

s - a String to check using regex

Returns:

true if the String is valid

isPunct

public static boolean isPunct(java.lang.String s)

Given a String the method uses Regex to check if the String only contains punctuation characters

Parameters:

s - a String to check using regex

Returns:

true if the String is valid

isAcronym

public static boolean isAcronym(java.lang.String s)

Given a String the method uses Regex to check if the String looks like an acronym

Parameters:

s - a String to check using regex

Returns:

true if the String is valid

getNotNullString

public static java.lang.String getNotNullString(java.lang.String s)

isNullOrEmpty

public static boolean isNullOrEmpty(java.lang.String str)

Returns whether a String is either null or empty. (Copies the Guava method for this.)

Parameters:

str - The String to test

Returns:

Whether the String is either null or empty

resolveVars

public static java.lang.String resolveVars(java.lang.String str,
                                           java.util.Map props)

Resolve variable. If it is the props file, then substitute that variable with the value mentioned in the props file, otherwise look for the variable in the environment variables. If the variable is not found then substitute it for empty string.

argsToPropertiesWithResolve

public static java.util.Properties argsToPropertiesWithResolve(java.lang.String[] args)

convert args to properties with variable names resolved. for each value having a ${VAR} or $VAR, its value is first resolved using the variables listed in the props file, and if not found then using the environment variables. if the variable is not found then substitute it for empty string

propFileToLinkedHashMap

public static java.util.LinkedHashMap<java.lang.String,java.lang.String> propFileToLinkedHashMap(java.lang.String filename,
                                                                                                 java.util.Map<java.lang.String,java.lang.String> existingArgs)

This method reads in properties listed in a file in the format prop=value, one property per line. and reads them into a LinkedHashMap (insertion order preserving) Flags not having any arguments is set to "true".

Parameters:

filename - A properties file to read

Returns:

The corresponding LinkedHashMap where the ordering is the same as in the props file

getNgrams

public static java.util.Collection<java.lang.String> getNgrams(java.util.List<java.lang.String> words,
                                                               int minSize,
                                                               int maxSize)

n grams for already split string. the ngrams are joined with a single space

getNgramsFromTokens

public static java.util.Collection<java.lang.String> getNgramsFromTokens(java.util.List<CoreLabel> words,
                                                                         int minSize,
                                                                         int maxSize)

n grams for already split string. the ngrams are joined with a single space

getNgramsString

public static java.util.Collection<java.lang.String> getNgramsString(java.lang.String s,
                                                                     int minSize,
                                                                     int maxSize)

The string is split on whitespace and the ngrams are joined with a single space

getCharacterNgrams

public static java.util.Collection<java.lang.String> getCharacterNgrams(java.lang.String s,
                                                                        int minSize,
                                                                        int maxSize)

Build a list of character-based ngrams from the given string.

normalize

public static java.lang.String normalize(java.lang.String s)

toString

public static java.lang.String toString(java.util.List<CoreLabel> words)

Convert a list of labels into a string, by simply joining them with spaces.

Parameters:

words - The words to join.

Returns:

A string representation of the sentence, tokenized by a single space.

toString

public static java.lang.String toString(CoreMap sentence)

Convert a CoreMap representing a sentence into a string, by simply joining them with spaces.

Parameters:

sentence - The sentence to stringify.

Returns:

A string representation of the sentence, tokenized by a single space.

levenshteinDistance

public static int levenshteinDistance(java.lang.String s1,
                                      java.lang.String s2)

I shamefully stole this from: http://rosettacode.org/wiki/Levenshtein_distance#Java --Gabor

levenshteinDistance

public static <E> int levenshteinDistance(E[] s1,
                                          E[] s2)

I shamefully stole this from: http://rosettacode.org/wiki/Levenshtein_distance#Java --Gabor

unescapeHtml3

public static java.lang.String unescapeHtml3(java.lang.String input)

Unescape an HTML string. Taken from: http://stackoverflow.com/questions/994331/java-how-to-decode-html-character-entities-in-java-like-httputility-htmldecode

Parameters:

input - The string to unescape

Returns:

The unescaped String

decodeArray

public static java.lang.String[] decodeArray(java.lang.String encoded)

Decode an array encoded as a String. This entails a comma separated value enclosed in brackets or parentheses.

Parameters:

encoded - The String encoding an array

Returns:

A String array corresponding to the encoded array

decodeMap

public static java.util.Map<java.lang.String,java.lang.String> decodeMap(java.lang.String encoded)

Decode a map encoded as a string.

Parameters:

encoded - The String encoded map

Returns:

A String map corresponding to the encoded map

expandEnvironmentVariables

public static java.lang.String expandEnvironmentVariables(java.lang.String raw,
                                                          java.util.Map<java.lang.String,java.lang.String> env)

Takes an input String, and replaces any bash-style variables (e.g., $VAR_NAME) with its actual environment variable from the passed environment specification.

Parameters:

raw - The raw String to replace variables in.

env - The environment specification; e.g., System.getenv().

Returns:

The input String, but with all variables replaced.

expandEnvironmentVariables

public static java.lang.String expandEnvironmentVariables(java.lang.String raw)

Takes an input String, and replaces any bash-style variables (e.g., $VAR_NAME) with its actual environment variable from System.getenv().

Parameters:

raw - The raw String to replace variables in.

Returns:

The input String, but with all variables replaced.

logInvocationString

public static void logInvocationString(Redwood.RedwoodChannels logger,
                                       java.lang.String[] args)

Logs the command line arguments to Redwood on the given channels. The logger should be a RedwoodChannels of a single channel: the main class.

Parameters:

logger - The redwood logger to log to.

args - The command-line arguments to log.

escapeJsonString

public static java.lang.String escapeJsonString(java.lang.String str)

indexOfRegex

public static int indexOfRegex(java.util.regex.Pattern pattern,
                               java.lang.String s)

Returns:

index of pattern (i.e., char position of start of pattern) in s or -1, if not found.

indexOfRegex

public static int indexOfRegex(java.util.regex.Pattern pattern,
                               java.lang.String s,
                               int index)

Returns:

index of pattern in s or -1, if not found, starting from index.