Utils (OLE 2.0.0-SNAPSHOT API)

java.lang.Object
- org.kuali.ole.utility.callnumber.Utils

```
public final class Utils
extends Object
```
General utility functions for solrmarc

Version:

$Id: Utils.java 1612 2012-03-21 17:39:16Z rh9ec@virginia.edu $

Author:

Wayne Graham

Field Summary

Fields
Modifier and Type Field and Description

protected static org.slf4j.Logger logger

Fields
Modifier and Type	Field and Description
`protected static org.slf4j.Logger`	`logger`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`calcTime(long totalTime)` Calculate time from milliseconds
`static String`	`cleanData(String origStr)` Removes trailing characters (space, comma, slash, semicolon, colon), trailing period if it is preceded by at least three letters, and single square bracket characters if they are the start and/or end chars of the cleaned string
`static String`	`cleanDate(String date)` Cleans non-digits from a String
`static char`	`foldDiacriticLatinChar(char c)` given a latin letter with a diacritic, return the latin letter without the diacritic.
`static Set<String>`	`getAllSubfields(org.marc4j.marc.Record record, String[] tags)` For each occurrence of a marc field in the tags list, extract all subfield data from the field, place it in a single string (individual subfield data separated by spaces) and add the string to the result set.
`static int`	`getIxUnescapedComma(String str)` return the index within this string of the first occurrence of a comma that isn't escaped with a backslash.
`static int`	`getIxUnescapedOpenParen(String str)` return the index within this string of the first occurrence of an open parenthesis that isn't escaped with a backslash.
`static Set<String>`	`getPrefixedVals(Set<String> valueSet, String prefix)` Look for Strings in the set, that start with the given prefix.
`static String`	`getProperty(Properties props, String propname)` Check first for a particular property in the System Properties, so that the -Dprop="value" command line arg mechanism can be used to override values defined in the passed in property file.
`static String`	`getProperty(Properties props, String propname, String defVal)` Check first for a particular property in the System Properties, so that the -Dprop="value" command line arg mechanism can be used to override values defined in the passed in property file.
`static String`	`getPropertyFileAbsoluteURL(String[] propertyPaths, String propertyFileName, boolean showName, String[] inputSource)`
`static InputStream`	`getPropertyFileInputStream(String propertyFileURLStr)`
`static InputStream`	`getPropertyFileInputStream(String[] propertyPaths, String propertyFileName)`
`static InputStream`	`getPropertyFileInputStream(String[] propertyPaths, String propertyFileName, boolean showName)`
`static InputStream`	`getPropertyFileInputStream(String[] propertyPaths, String propertyFileName, boolean showName, String[] inputSource)`
`static String`	`getSubfieldData(org.marc4j.marc.DataField df, char code)` get the contents of a subfield, rigorously ensuring no NPE
`static List<String>`	`getSubfieldStrings(org.marc4j.marc.DataField df, char code)` returns all values of subfield strings of a particular code contained in the data field
`static boolean`	`isNumber(String number)` Test if a String has a numeric equivalent
`static boolean`	`isRightToLeftLanguage(String langcode)` returns true if the 3 letter language code is for a right to left language (one written in arabic or hebrew characters)
`static String`	`join(Set<String> set, String separator)` Join two fields together with seperator
`static Properties`	`loadProperties(String fullFilenameURLStr)` load a properties file into a Properties object
`static Properties`	`loadProperties(String[] propertyPaths, String propertyFileName)` load a properties file into a Properties object
`static Properties`	`loadProperties(String[] propertyPaths, String propertyFileName, boolean showName)` load a properties file into a Properties object
`static Properties`	`loadProperties(String[] propertyPaths, String propertyFileName, boolean showName, String filenameProperty)` load a properties file into a Properties object
`static String`	`readStreamIntoString(InputStream stream)` Takes an InputStream, reads the entire contents into a String
`static Set<String>`	`remap(Set<String> set, Map<String,String> map, boolean allowDefault)` Remap a set of field values.
`static String`	`remap(String fieldVal, Map<String,String> map, boolean allowDefault)` Remap a field value.
`static String`	`removeAllTrailingCharAndPeriod(String origStr, String trailingCharsRegEx, String charsB4periodRegEx)` Repeatedly removes trailing characters indicated in regular expression, PLUS trailing period if it is preceded by its regular expression
`static String`	`removeOuterBrackets(String origStr)` Remove single square bracket characters if they are the start and/or end chars (matched or unmatched) and are the only square bracket chars in the string.
`static String`	`removePrefix(String value, String prefix)` remove prefix from the beginning of the value string.
`static String`	`removeTrailingChar(String origStr, String charsToReplaceRegEx)` Remove the characters per the regular expression if they are at the end of the string.
`static String`	`removeTrailingCharAndPeriod(String origStr, String trailingCharsRegEx, String charsB4periodRegEx)` Removes trailing characters indicated in regular expression, PLUS trailing period if it is preceded by its regular expression.
`static String`	`removeTrailingPeriod(String origStr, String precedingCharsRegEx)` If there is a period at the end of the string, remove the period if it is immediately preceded by the regular expression
`static Set<String>`	`returnValidISBNs(Set<String> candidates)` returns the valid ISBN(s) from the set of candidate Strings
`static boolean`	`setItemContains(Set<String> set, String pattern)` Test if a set contains a specified pattern
`static Set<String>`	`trimNearDuplicates(Set<String> locations)`

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

- Field Detail
  - logger
```
protected static org.slf4j.Logger logger
```
- Method Detail
  - getProperty
```
public static String getProperty(Properties props,
                 String propname)
```
    Check first for a particular property in the System Properties, so that the -Dprop="value" command line arg mechanism can be used to override values defined in the passed in property file. This is especially useful for defining the marc.source property to define which file to operate on, in a shell script loop.
    
    Parameters:
    props - - property set in which to look.
    propname - - name of the property to lookup.
  - getProperty
```
public static String getProperty(Properties props,
                 String propname,
                 String defVal)
```
    Check first for a particular property in the System Properties, so that the -Dprop="value" command line arg mechanism can be used to override values defined in the passed in property file. This is especially useful for defining the marc.source property to define which file to operate on, in a shell script loop.
    
    Parameters:
    props - - property set in which to look.
    propname - - name of the property to lookup.
    defVal - - the default value to use if property is not defined
  - loadProperties
```
public static Properties loadProperties(String[] propertyPaths,
                        String propertyFileName)
```
    load a properties file into a Properties object
    
    Parameters:
    propertyPaths - the directories to search for the properties file
    propertyFileName - name of the sought properties file
    
    Returns:
    Properties object
  - loadProperties
```
public static Properties loadProperties(String[] propertyPaths,
                        String propertyFileName,
                        boolean showName)
```
    load a properties file into a Properties object
    
    Parameters:
    propertyPaths - the directories to search for the properties file
    propertyFileName - name of the sought properties file
    
    Returns:
    Properties object
  - loadProperties
```
public static Properties loadProperties(String fullFilenameURLStr)
```
    load a properties file into a Properties object
    
    Parameters:
    fullFilenameURLStr - String representation of url to properties file whether it is in a local file or a resource
    
    Returns:
    Properties object
  - loadProperties
```
public static Properties loadProperties(String[] propertyPaths,
                        String propertyFileName,
                        boolean showName,
                        String filenameProperty)
```
    load a properties file into a Properties object
    
    Parameters:
    propertyPaths - the directories to search for the properties file
    propertyFileName - name of the sought properties file
    showName - whether the name of the file/resource being read should be shown.
    
    Returns:
    Properties object
  - getPropertyFileInputStream
```
public static InputStream getPropertyFileInputStream(String[] propertyPaths,
                                     String propertyFileName)
```
  - getPropertyFileInputStream
```
public static InputStream getPropertyFileInputStream(String[] propertyPaths,
                                     String propertyFileName,
                                     boolean showName)
```
  - getPropertyFileInputStream
```
public static InputStream getPropertyFileInputStream(String propertyFileURLStr)
```
  - getPropertyFileInputStream
```
public static InputStream getPropertyFileInputStream(String[] propertyPaths,
                                     String propertyFileName,
                                     boolean showName,
                                     String[] inputSource)
```
  - getPropertyFileAbsoluteURL
```
public static String getPropertyFileAbsoluteURL(String[] propertyPaths,
                                String propertyFileName,
                                boolean showName,
                                String[] inputSource)
```
  - readStreamIntoString
```
public static String readStreamIntoString(InputStream stream)
                                   throws IOException
```
    Takes an InputStream, reads the entire contents into a String
    
    Parameters:
    stream - - the stream to read in.
    
    Returns:
    String containing entire contents of stream.
    
    Throws:
    
    IOException
  - cleanDate
```
public static String cleanDate(String date)
```
    Cleans non-digits from a String
    
    Parameters:
    date - String to parse
    
    Returns:
    Numeric part of date String (or null)
  - cleanData
```
public static String cleanData(String origStr)
```
    Removes trailing characters (space, comma, slash, semicolon, colon), trailing period if it is preceded by at least three letters, and single square bracket characters if they are the start and/or end chars of the cleaned string
    
    Parameters:
    origStr - String to clean
    
    Returns:
    cleaned string
  - removeAllTrailingCharAndPeriod
```
public static String removeAllTrailingCharAndPeriod(String origStr,
                                    String trailingCharsRegEx,
                                    String charsB4periodRegEx)
```
    Repeatedly removes trailing characters indicated in regular expression, PLUS trailing period if it is preceded by its regular expression
    
    Parameters:
    origStr - String to clean
    trailingCharsRegEx - a regular expression of trailing chars to be removed (see java Pattern class). Note that the regular expression should NOT have '$' at the end. (e.g. " *[,/;:]" replaces any commas, slashes, semicolons or colons at the end of the string, and these chars may optionally be preceded by a space)
    charsB4periodRegEx - a regular expression that must immediately precede a trailing period IN ORDER FOR THE PERIOD TO BE REMOVED. Note that the regular expression will NOT have the period or '$' at the end. (e.g. "[a-zA-Z]{3,}" means at least three letters must immediately precede the period for it to be removed.)
    
    Returns:
    cleaned string
  - removeTrailingCharAndPeriod
```
public static String removeTrailingCharAndPeriod(String origStr,
                                 String trailingCharsRegEx,
                                 String charsB4periodRegEx)
```
    Removes trailing characters indicated in regular expression, PLUS trailing period if it is preceded by its regular expression.
    
    Parameters:
    origStr - String to clean
    trailingCharsRegEx - a regular expression of trailing chars to be removed (see java Pattern class). Note that the regular expression should NOT have '$' at the end. (e.g. " *[,/;:]" replaces any commas, slashes, semicolons or colons at the end of the string, and these chars may optionally be preceded by a space)
    charsB4periodRegEx - a regular expression that must immediately precede a trailing period IN ORDER FOR THE PERIOD TO BE REMOVED. Note that the regular expression will NOT have the period or '$' at the end. (e.g. "[a-zA-Z]{3,}" means at least three letters must immediately precede the period for it to be removed.)
    
    Returns:
    cleaned string
  - removeTrailingChar
```
public static String removeTrailingChar(String origStr,
                        String charsToReplaceRegEx)
```
    Remove the characters per the regular expression if they are at the end of the string.
    
    Parameters:
    origStr - string to be cleaned
    charsToReplaceRegEx - - a regular expression of the trailing string/chars to be removed e.g. " *([,/;:])" meaning last character is a comma, slash, semicolon, colon, possibly preceded by one or more spaces.
    
    Returns:
    the string with the specified trailing characters removed
    See Also:
    class in java api
  - removeTrailingPeriod
```
public static String removeTrailingPeriod(String origStr,
                          String precedingCharsRegEx)
```
    If there is a period at the end of the string, remove the period if it is immediately preceded by the regular expression
    
    Parameters:
    origStr - the string to be cleaned
    charsB4periodRegEx - a regular expression that must immediately precede a trailing period IN ORDER FOR THE PERIOD TO BE REMOVED. Note that the regular expression will NOT have the period or '$' at the end. (e.g. "[a-zA-Z]{3,}" means at least three letters must immediately precede the period for it to be removed.)
    
    Returns:
    the string without a trailing period iff the regular expression param was found immediately before the trailing period
  - removeOuterBrackets
```
public static String removeOuterBrackets(String origStr)
```
    Remove single square bracket characters if they are the start and/or end chars (matched or unmatched) and are the only square bracket chars in the string.
  - calcTime
```
public static String calcTime(long totalTime)
```
    Calculate time from milliseconds
    
    Parameters:
    totalTime - Time in milliseconds
    
    Returns:
    Time in the format mm:ss.ss
  - isNumber
```
public static boolean isNumber(String number)
```
    Test if a String has a numeric equivalent
    
    Parameters:
    number - String representation of a number
    
    Returns:
    True if String is a number; False if it is not
  - remap
```
public static String remap(String fieldVal,
           Map<String,String> map,
           boolean allowDefault)
```
    Remap a field value. If the field value is not present in the map, then: if "displayRawIfMissing" is a key in the map, then the raw field value is used. if "displayRawIfMissing" is not a key in the map, and the allowDefault param is set to true, then if the map contains "__DEFAULT" as a key, the value of "__DEFAULT" in the map is used; if allowDefault is true and there is neither "displayRawIfMissing" nor "__DEFAULT", as a key in the map, then if the map contains an empty key, the map value of the empty key is used. NOTE: If the spec for a field is supposed to contain all matching values, then the default lookup needs to be done here. If the spec for a field is only supposed to return the first matching mappable value, then the default mapping should be done in the calling method
    
    Parameters:
    fieldVal - - the raw value to be mapped
    map - - the map to be used
    allowDefault - - if "displayRawIfMissing" is not a key in the map, and this is to true, then if the map contains "__DEFAULT" as a key, the value of "__DEFAULT" in the map is used.
    
    Returns:
    the new value, as determined by the mapping.
  - remap
```
public static Set<String> remap(Set<String> set,
                Map<String,String> map,
                boolean allowDefault)
```
    Remap a set of field values. If a field value is not present in the map, then: if "displayRawIfMissing" is a key in the map, then the raw field value is used. if "displayRawIfMissing" is not a key in the map, and the allowDefault param is set to true, then if the map contains "__DEFAULT" as a key, the value of "__DEFAULT" in the map is used; if allowDefault is true and there is neither "displayRawIfMissing" nor "__DEFAULT", as a key in the map, then if the map contains an empty key, the map value of the empty key is used. NOTE: If the spec for a field is supposed to contain all matching values, then the default lookup needs to be done here. If the spec for a field is only supposed to return the first matching mappable value, then the default mapping should be done in the calling method
    
    Parameters:
    fieldVal - - the raw value to be mapped
    map - - the map to be used
    allowDefault - - if "displayRawIfMissing" is not a key in the map, and this is to true, then if the map contains "__DEFAULT" as a key, the value of "__DEFAULT" in the map is used.
    
    Returns:
    the new value, as determined by the mapping.
  - setItemContains
```
public static boolean setItemContains(Set<String> set,
                      String pattern)
```
    Test if a set contains a specified pattern
    
    Parameters:
    set - Set of marc fields to test
    pattern - Regex String pattern to match
    
    Returns:
    If the set contains the pattern, return true, else false
  - join
```
public static String join(Set<String> set,
          String separator)
```
    Join two fields together with seperator
    
    Parameters:
    set - Set of marc fields to join
    separator - Separation character to put between
    
    Returns:
    Joined fields
  - trimNearDuplicates
```
public static Set<String> trimNearDuplicates(Set<String> locations)
```
  - isRightToLeftLanguage
```
public static final boolean isRightToLeftLanguage(String langcode)
```
    returns true if the 3 letter language code is for a right to left language (one written in arabic or hebrew characters)
    
    Parameters:
    langcode -
    
    Returns:
  - getIxUnescapedOpenParen
```
public static final int getIxUnescapedOpenParen(String str)
```
    return the index within this string of the first occurrence of an open parenthesis that isn't escaped with a backslash.
    
    Parameters:
    str -
    
    Returns:
    if an unescaped open parenthesis occurs within this object, return the index of the first open paren; -1 if no unescaped open paren.
  - getIxUnescapedComma
```
public static final int getIxUnescapedComma(String str)
```
    return the index within this string of the first occurrence of a comma that isn't escaped with a backslash.
    
    Parameters:
    str -
    
    Returns:
    if an unescaped comma occurs within this object, the index of the first comma; -1 if no unescaped comma.
  - getPrefixedVals
```
public static final Set<String> getPrefixedVals(Set<String> valueSet,
                          String prefix)
```
    Look for Strings in the set, that start with the given prefix. If found, remove the prefix, trim the result and add it to the returned set of Strings to be returned.
    
    Parameters:
    valueSet -
    prefix -
    
    Returns:
    set members that had the prefix, but now prefix is removed and remaining value is trimmed.
  - removePrefix
```
public static final String removePrefix(String value,
                  String prefix)
```
    remove prefix from the beginning of the value string.
  - returnValidISBNs
```
public static Set<String> returnValidISBNs(Set<String> candidates)
```
    returns the valid ISBN(s) from the set of candidate Strings
    
    Returns:
    Set of strings containing valid ISBN numbers
  - getAllSubfields
```
public static final Set<String> getAllSubfields(org.marc4j.marc.Record record,
                          String[] tags)
```
    For each occurrence of a marc field in the tags list, extract all subfield data from the field, place it in a single string (individual subfield data separated by spaces) and add the string to the result set.
  - getSubfieldData
```
public static final String getSubfieldData(org.marc4j.marc.DataField df,
                     char code)
```
    get the contents of a subfield, rigorously ensuring no NPE
    
    Parameters:
    df - - DataField of interest
    code - - code of subfield of interest
    
    Returns:
    the contents of the subfield, if it exists; null otherwise
  - getSubfieldStrings
```
public static final List<String> getSubfieldStrings(org.marc4j.marc.DataField df,
                              char code)
```
    returns all values of subfield strings of a particular code contained in the data field
  - foldDiacriticLatinChar
```
public static char foldDiacriticLatinChar(char c)
```
    given a latin letter with a diacritic, return the latin letter without the diacritic. Shamelessly stolen from UnicodeCharUtil class of UnicodeNormalizeFilter by Bob Haschart

Class Utils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

Method Detail

getProperty

getProperty

loadProperties

loadProperties

loadProperties

loadProperties

getPropertyFileInputStream

getPropertyFileInputStream

getPropertyFileInputStream

getPropertyFileInputStream

getPropertyFileAbsoluteURL

readStreamIntoString

cleanDate

cleanData

removeAllTrailingCharAndPeriod

removeTrailingCharAndPeriod

removeTrailingChar

removeTrailingPeriod

removeOuterBrackets

calcTime

isNumber

remap

remap

setItemContains

join

trimNearDuplicates

isRightToLeftLanguage

getIxUnescapedOpenParen

getIxUnescapedComma

getPrefixedVals

removePrefix

returnValidISBNs

getAllSubfields

getSubfieldData

getSubfieldStrings

foldDiacriticLatinChar