com.screenscraper.util.parsing.name

Class EnglishNameParser.Builder

java.lang.Object

com.screenscraper.util.parsing.name.EnglishNameParser.Builder

Enclosing class:

EnglishNameParser

public static class EnglishNameParser.Builder
extends java.lang.Object

Builder class used to build parsers for english names. It is safe to use the same builder to create multiple parsers, modifying the parameters each time. The class is not, however, thread safe

Constructor Summary

Constructors

Constructor and Description
Builder() Initialize the builder

Method Summary

Modifier and Type	Method and Description
EnglishNameParser.Builder	appendGenerationalSuffixes(java.util.Collection<java.lang.String> generationalSuffixes) Adds to the current set of generational suffixes that this will parser will look for
EnglishNameParser.Builder	appendHonorifics(java.util.Collection<java.lang.String> honorifics) Adds to the current set of honorifics that this will parser will look for
EnglishNameParser.Builder	appendLastNamePrepends(java.util.Collection<java.lang.String> lastNamePrepends) Adds to the current set of last name prepends (De d' etc...) that this will parser will look for
EnglishNameParser.Builder	appendSuffixes(java.util.Collection<java.lang.String> suffixes) Adds to the current set of suffixes that this will parser will look for
EnglishNameParser.Builder	blackListRegex(java.util.Set<java.util.regex.Pattern> blackListRegex) Sets the black list regular expressions
EnglishNameParser	build()
EnglishNameParser.Builder	generationalSuffixes(java.util.Collection<java.lang.String> generationalSuffixes) Sets the set of generational suffixes that this will parser will look for
EnglishNameParser.Builder	honorifics(java.util.Collection<java.lang.String> honorifics) Sets the set of honorifics that this will parser will look for
EnglishNameParser.Builder	lastNamePrepends(java.util.Collection<java.lang.String> lastNamePrepends) Sets the set of last name prepends (De d' etc...) that this will parser will look for
EnglishNameParser.Builder	removeRegex(java.lang.String removeRegex) Sets the regular expression that will be replaced with an empty string in all name pieces
EnglishNameParser.Builder	suffixes(java.util.Collection<java.lang.String> suffixes) Sets the set of suffixes that this will parser will look for
java.lang.String	toString()
EnglishNameParser.Builder	whiteListRegex(java.util.Set<java.util.regex.Pattern> whiteListRegex) Sets the white list regular expressions

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Initialize the builder

Method Detail

removeRegex

@NotNull
public EnglishNameParser.Builder removeRegex(@NotNull
                                                       java.lang.String removeRegex)

Sets the regular expression that will be replaced with an empty string in all name pieces

Parameters:

removeRegex - The regular expression to remove

Returns:

The builder for method chaining

suffixes

@NotNull
public EnglishNameParser.Builder suffixes(@NotNull
                                                    java.util.Collection<java.lang.String> suffixes)

Sets the set of suffixes that this will parser will look for

Parameters:

suffixes - The set of suffixes to check for

Returns:

The builder for method chaining

appendSuffixes

@NotNull
public EnglishNameParser.Builder appendSuffixes(@NotNull
                                                          java.util.Collection<java.lang.String> suffixes)

Adds to the current set of suffixes that this will parser will look for

Parameters:

suffixes - The additional suffixes to check for

Returns:

The builder for method chaining

generationalSuffixes

@NotNull
public EnglishNameParser.Builder generationalSuffixes(@NotNull
                                                                java.util.Collection<java.lang.String> generationalSuffixes)

Sets the set of generational suffixes that this will parser will look for

Parameters:

generationalSuffixes - The set of generational suffixes to check for

Returns:

The builder for method chaining

appendGenerationalSuffixes

@NotNull
public EnglishNameParser.Builder appendGenerationalSuffixes(@NotNull
                                                                      java.util.Collection<java.lang.String> generationalSuffixes)

Adds to the current set of generational suffixes that this will parser will look for

Parameters:

generationalSuffixes - The additional generational suffixes to check for

Returns:

The builder for method chaining

honorifics

@NotNull
public EnglishNameParser.Builder honorifics(@NotNull
                                                      java.util.Collection<java.lang.String> honorifics)

Sets the set of honorifics that this will parser will look for

Parameters:

honorifics - The set of honorifics to check for

Returns:

The builder for method chaining

appendHonorifics

@NotNull
public EnglishNameParser.Builder appendHonorifics(@NotNull
                                                            java.util.Collection<java.lang.String> honorifics)

Adds to the current set of honorifics that this will parser will look for

Parameters:

honorifics - The additional honorifics to check for

Returns:

The builder for method chaining

lastNamePrepends

@NotNull
public EnglishNameParser.Builder lastNamePrepends(@NotNull
                                                            java.util.Collection<java.lang.String> lastNamePrepends)

Sets the set of last name prepends (De d' etc...) that this will parser will look for

Parameters:

lastNamePrepends - The set of last name prepends to check for

Returns:

The builder for method chaining

appendLastNamePrepends

@NotNull
public EnglishNameParser.Builder appendLastNamePrepends(@NotNull
                                                                  java.util.Collection<java.lang.String> lastNamePrepends)

Adds to the current set of last name prepends (De d' etc...) that this will parser will look for

Parameters:

lastNamePrepends - The additional last name prepends to check for

Returns:

The builder for method chaining

blackListRegex

@NotNull
public EnglishNameParser.Builder blackListRegex(@NotNull
                                                          java.util.Set<java.util.regex.Pattern> blackListRegex)

Sets the black list regular expressions

Parameters:

blackListRegex - A set of regular expressions for black list checks

Returns:

The builder for method chaining

whiteListRegex

@NotNull
public EnglishNameParser.Builder whiteListRegex(@NotNull
                                                          java.util.Set<java.util.regex.Pattern> whiteListRegex)

Sets the white list regular expressions

Parameters:

whiteListRegex - A set of regular expressions for white list checks

Returns:

The builder for method chaining

build

@NotNull
public EnglishNameParser build()

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object