com.screenscraper.util.parsing.address

Interface AddressParser

All Known Implementing Classes:

USAddressParser

public interface AddressParser

Interface for parsing addresses

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AddressParser.ParseHint An enumeration of hints for parsing.

Method Summary

Modifier and Type	Method and Description
void	close() Closes any open resources in use by the parser
Address	parse(java.lang.String address) Attempts to parse the string given as an address.
Address	parse(java.lang.String address, AddressParser.ParseHint... hints) Attempts to parse the string given as an address.
void	setAutoCloseAfterScrapeEnds(ScrapingSession session) Tells the data manager to close when the scrape ends.

Method Detail

parse

@Nullable
Address parse(@NotNull
                         java.lang.String address)
                  throws java.text.ParseException

Attempts to parse the string given as an address.

Parameters:

address - The string to parse as an address

Returns:

The Address from the string

Throws:

java.text.ParseException - If there is an error parsing the address. Not throwing the exception doesn't indicate we know the parse has correct data, but there are some cases when we know the parsed data is invalid

parse

@Nullable
Address parse(@NotNull
                         java.lang.String address,
                         @NotNull
                         AddressParser.ParseHint... hints)
                  throws java.text.ParseException

Attempts to parse the string given as an address.

Parameters:

address - The string to parse as an address

hints - The hints to use when parsing

Returns:

The Address from the string

Throws:

java.text.ParseException - If there is an error parsing the address. Not throwing the exception doesn't indicate we know the parse has correct data, but there are some cases when we know the parsed data is invalid

close

void close()

Closes any open resources in use by the parser

setAutoCloseAfterScrapeEnds

void setAutoCloseAfterScrapeEnds(@NotNull
                                 ScrapingSession session)

Tells the data manager to close when the scrape ends. Calling this method will close the data manager automatically when the scrape ends. If the session was stopped, it will clear the data that is set to be written, otherwise it will call flush before closing.

Parameters:

session - The scraping session this should use to check for closing on completion

Since:

7.0.2a