com.tupilabs.human_name_parser

Class Name

java.lang.Object

com.tupilabs.human_name_parser.Name

public class Name
extends java.lang.Object

A Name object that encapsulates a name string, and contains the logic for handling with Regexes.

This class is not thread-safe.

Since:

0.1

Constructor Summary

Constructors

Constructor and Description
Name(java.lang.String str) Creates a new Name object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	chopWithRegex(java.lang.String regex, int submatchIndex) Uses a regex to chop off and return part of the namestring.
void	flip(java.lang.String flipAroundChar) Flips the front and back parts of a name with one another.
java.lang.String	getStr() Gets the encapsulated string.
void	norm() Removes extra whitespace and punctuation from this.str.
void	setStr(java.lang.String str) Sets the encapsulated string value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Name

public Name(java.lang.String str)

Creates a new Name object.

Parameters:

str - encapsulated string.

Method Detail

getStr

public java.lang.String getStr()

Gets the encapsulated string.

Returns:

encapsulated string

setStr

public void setStr(java.lang.String str)

Sets the encapsulated string value.

Parameters:

str - string value

chopWithRegex

public java.lang.String chopWithRegex(java.lang.String regex,
                                      int submatchIndex)

Uses a regex to chop off and return part of the namestring. There are two parts: first, it returns the matched substring, and then it removes that substring from the encapsulated string and normalizes it.

Parameters:

regex - matches the part of the namestring to chop off

submatchIndex - which of the parenthesized submatches to use

Returns:

the part of the namestring that got chopped off

flip

public void flip(java.lang.String flipAroundChar)
          throws ParseException

Flips the front and back parts of a name with one another. Front and back are determined by a specified character somewhere in the middle of the string.

Parameters:

flipAroundChar - the character(s) demarcating the two halves you want to flip.

Throws:

ParseException - if a regex fails or a condition is not expected

norm

public void norm()

Removes extra whitespace and punctuation from this.str.

Strips whitespace chars from ends, strips redundant whitespace, converts whitespace chars to " ".