com.screenscraper.util.parsing.address

Class USAddressParser.USAddressParserBuilder

java.lang.Object

com.screenscraper.util.parsing.address.USAddressParser.USAddressParserBuilder

Enclosing class:

USAddressParser

public static class USAddressParser.USAddressParserBuilder
extends java.lang.Object

Builder class used to setup a USAddressParser

Constructor Summary

Constructors

Constructor and Description
USAddressParserBuilder() Creates the builder used to customize what values are parsed

Method Summary

Modifier and Type	Method and Description
USAddressParser.USAddressParserBuilder	addMissingInformation(boolean addMissingInformation) Sets whether the parser should add missing information if found.
USAddressParser.USAddressParserBuilder	appendCountryWords(java.util.Collection<java.lang.String> countryWords) Appends a new collection of accepted countries, as regular expressions
USAddressParser.USAddressParserBuilder	appendEndAddressWords(java.util.Collection<java.lang.String> endAddressWords) Appends a new collection of end address words used to detect the end of the street.
USAddressParser.USAddressParserBuilder	appendSecondaryAddressLineWords(java.util.Collection<java.lang.String> secondaryAddressLineWords) Appends to the secondary address line words, as regular expressions, to indicate what forms a secondary address
USAddressParser.USAddressParserBuilder	appendStateWords(java.util.Collection<java.lang.String> stateWords) Appends a new collection of accepted states, as regular expressions
USAddressParser	build() Creates an instance of the built type using the values currently set in the builder
USAddressParser.USAddressParserBuilder	countryWords(java.util.Collection<java.lang.String> countryWords) Sets a new collection of accepted countries, as regular expressions
USAddressParser.USAddressParserBuilder	endAddressWords(java.util.Collection<java.lang.String> endAddressWords) Sets a new collection of end address words used to detect the end of the street.
USAddressParser.USAddressParserBuilder	lookUpDataSource(javax.sql.DataSource lookUpDataSource) Sets whether the parses uses a lookup system to get more accurate results.
USAddressParser.USAddressParserBuilder	secondaryAddressLineWords(java.util.Collection<java.lang.String> secondaryAddressLineWords) Sets the secondary address line words, as regular expressions, to indicate what forms a secondary address
USAddressParser.USAddressParserBuilder	stateWords(java.util.Collection<java.lang.String> stateWords) Sets a new collection of accepted states, as regular expressions
java.lang.String	toString()
USAddressParser.USAddressParserBuilder	zipCodePattern(java.lang.String zipCodePattern) Sets the zip code pattern that will be applied to find zipcodes at the end of an address string

Methods inherited from class java.lang.Object

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

Constructor Detail

USAddressParserBuilder

public USAddressParserBuilder()

Creates the builder used to customize what values are parsed

Method Detail

endAddressWords

@NotNull
public USAddressParser.USAddressParserBuilder endAddressWords(@NotNull
                                                                        java.util.Collection<java.lang.String> endAddressWords)

Sets a new collection of end address words used to detect the end of the street. These should be regular expressions and should include anything before the word to help it match.

Parameters:

endAddressWords - A collection of new end address words, as regular expressions

Returns:

The reference to the builder for convenience in method chaining

appendEndAddressWords

@NotNull
public USAddressParser.USAddressParserBuilder appendEndAddressWords(@NotNull
                                                                              java.util.Collection<java.lang.String> endAddressWords)

Appends a new collection of end address words used to detect the end of the street. These should be regular expressions and should include anything before the word to help it match.

Parameters:

endAddressWords - A collection of new end address words, as regular expressions

Returns:

The reference to the builder for convenience in method chaining

secondaryAddressLineWords

@NotNull
public USAddressParser.USAddressParserBuilder secondaryAddressLineWords(@NotNull
                                                                                  java.util.Collection<java.lang.String> secondaryAddressLineWords)

Sets the secondary address line words, as regular expressions, to indicate what forms a secondary address

Parameters:

secondaryAddressLineWords - The collections of new regular expressions to match for secondary address lines

Returns:

The builder, for method chaining

appendSecondaryAddressLineWords

@NotNull
public USAddressParser.USAddressParserBuilder appendSecondaryAddressLineWords(@NotNull
                                                                                        java.util.Collection<java.lang.String> secondaryAddressLineWords)

Appends to the secondary address line words, as regular expressions, to indicate what forms a secondary address

Parameters:

secondaryAddressLineWords - The collections of new regular expressions to match for secondary address lines

Returns:

The builder, for method chaining

countryWords

@NotNull
public USAddressParser.USAddressParserBuilder countryWords(@NotNull
                                                                     java.util.Collection<java.lang.String> countryWords)

Sets a new collection of accepted countries, as regular expressions

Parameters:

countryWords - A collection of new countries, as regular expressions

Returns:

The reference to the builder for convenience in method chaining

appendCountryWords

@NotNull
public USAddressParser.USAddressParserBuilder appendCountryWords(@NotNull
                                                                           java.util.Collection<java.lang.String> countryWords)

Appends a new collection of accepted countries, as regular expressions

Parameters:

countryWords - A collection of new countries, as regular expressions

Returns:

The reference to the builder for convenience in method chaining

stateWords

@NotNull
public USAddressParser.USAddressParserBuilder stateWords(@NotNull
                                                                   java.util.Collection<java.lang.String> stateWords)

Sets a new collection of accepted states, as regular expressions

Parameters:

stateWords - A collection of new states, as regular expressions

Returns:

The reference to the builder for convenience in method chaining

appendStateWords

@NotNull
public USAddressParser.USAddressParserBuilder appendStateWords(@NotNull
                                                                         java.util.Collection<java.lang.String> stateWords)

Appends a new collection of accepted states, as regular expressions

Parameters:

stateWords - A collection of new states, as regular expressions

Returns:

The reference to the builder for convenience in method chaining

zipCodePattern

@NotNull
public USAddressParser.USAddressParserBuilder zipCodePattern(@NotNull
                                                                       java.lang.String zipCodePattern)

Sets the zip code pattern that will be applied to find zipcodes at the end of an address string

Parameters:

zipCodePattern - The zip code pattern to apply

Returns:

The reference to the builder for convenience in method chaining

lookUpDataSource

@NotNull
public USAddressParser.USAddressParserBuilder lookUpDataSource(javax.sql.DataSource lookUpDataSource)

Sets whether the parses uses a lookup system to get more accurate results. This will significantly slow the parsing speed. The database that is passed in should connect to a MySQL database with a table / view named "us_cities" with fields named city, state, zip, state_code, county, country_code

Parameters:

lookUpDataSource - A non-null value indicates look ups will be performed using the given source. Null indicates not to perform look ups

Returns:

The builder for method chaining

addMissingInformation

@NotNull
public USAddressParser.USAddressParserBuilder addMissingInformation(boolean addMissingInformation)

Sets whether the parser should add missing information if found. For example, if the address was "123 North Lindon Utah" we could parse out the city and state, and then lookup the zip code and add it, even though it wasn't in the original address. This only works when using a data source.

Parameters:

addMissingInformation - True to add information obtained through the database, false to only store parsed data

Returns:

The builder for method chaining

build

@Nullable
public USAddressParser build()

Creates an instance of the built type using the values currently set in the builder

Returns:

An instance of the built type that is constructed with the current values set in the builder

Throws:

java.lang.IllegalStateException - If the current state of the builder cannot produce a valid object of type T

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object