org.transitime.gtfs

Class TitleFormatter

java.lang.Object

org.transitime.gtfs.TitleFormatter

public class TitleFormatter
extends java.lang.Object

Tool for formatting titles in the GTFS data. Need to be able to "unshout" titles (change "MAIN ST" to "Main St") yet capitalize abbreviations (e.g. "BART" or "US"). Can also make sure that when using "&" or "@" that they have consistent spaces around them. The way this is done is that first the capitalization of the title is fixed. Each word starting at a delimiter is capitalized while other characters are made lower case. Then regular expressions are used to do special processing. The regular expressions are put into a file so that each agency can have a particular list. The file name is passed to the constructor when creating a TitleFormatter. Some examples of regular expressions and their corresponding replacement text that can be useful for fixing titles are shown below. Useful documentation at http://www.regular-expressions.info and at http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html -- For fixing capitalization of O'shaughnessy O's=>O'S -- For fixing capitalization of abbreviation Bart=>BART -- For making sure there is space after a '&'. -- Note that "(?! )" means not a whitespace char -- and means the non-whitespace char -- will not actually get replaced. &(?! )=>&_ NOTE: last char actually a space! -- For making sure there is space before a '&'. (? &

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
TitleFormatter(java.lang.String regexReplaceListFileName, boolean logUnusedRegexs) Member Functions

Method Summary

Modifier and Type	Method and Description
void	logRegexesThatDidNotMakeDifference() Logs which configured regexs haven't made a difference.
java.lang.String	processTitle(java.lang.String original) Takes a title, obtained from GTFS data, and makes it more readable.

Methods inherited from class java.lang.Object

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

Constructor Detail

TitleFormatter

public TitleFormatter(java.lang.String regexReplaceListFileName,
                      boolean logUnusedRegexs)

Member Functions

Method Detail

processTitle

public java.lang.String processTitle(java.lang.String original)

Takes a title, obtained from GTFS data, and makes it more readable. First capitalized the text as well as possible. Then runs the configured regexs across the title so that other problems can be fixed. If many regexs are configured this could take a lot of processing time if there are a large number of titles.

Parameters:

The - original title. Can be null

Returns:

The formatted title. Null if passed in null.

logRegexesThatDidNotMakeDifference

public void logRegexesThatDidNotMakeDifference()

Logs which configured regexs haven't made a difference. These could perhaps be unconfigured to speed up processing.