oracle.panama.spatial.yp
Interface YPFinderSimple

All Known Subinterfaces:

YPFinder

public interface YPFinderSimple

This interface defines a service object that can find businesses in a given area that match either a name or category. This interface is used for classes implemented for specific external providers. The general management class YPFinderImpl implements another interface, YPFinder, that extends this interface. Any class implementing this interface should be thread-safe.

Method Summary

java.lang.Boolean	anyBusinessesInCity(YPCategory category, java.lang.String country, java.lang.String state, java.lang.String city) Deprecated.
java.lang.Boolean	anyBusinessesInPCode(YPCategory category, java.lang.String country, java.lang.String postalCode) Deprecated.
java.lang.Boolean	anyBusinessesInRadius(YPCategory category, Point location, double metersRadius) Deprecated.
java.lang.Boolean	anyBusinessesInSameCity(YPCategory category, Location loc) Deprecated.
java.lang.Boolean	anyBusinessesInSamePCode(YPCategory category, Location loc) Deprecated.
java.lang.Boolean	anyBusinessesInSameState(YPCategory category, Location loc) Deprecated.
java.lang.Boolean	anyBusinessesInState(YPCategory category, java.lang.String country, java.lang.String state) Deprecated.
YPBusiness[]	getBusinessesAnywhere(java.lang.String businessName, java.util.Locale locale) This returns all businesses matching a specified name.
YPBusiness[]	getBusinessesAnywhere(java.lang.String businessName, YPCategory category, java.util.Locale locale) This returns all businesses conforming to a specified name and category.
YPBusiness[]	getBusinessesAnywhere(YPCategory category, java.util.Locale locale) This returns all businesses in a specified category.
YPBusiness[]	getBusinessesInCity(java.lang.String businessName, java.lang.String country, java.lang.String state, java.lang.String city, java.util.Locale locale) This returns all businesses matching a specified name in a specified city.
YPBusiness[]	getBusinessesInCity(java.lang.String businessName, YPCategory category, java.lang.String country, java.lang.String state, java.lang.String city, java.util.Locale locale) This returns all businesses conforming to a specified name, category and city.
YPBusiness[]	getBusinessesInCity(YPCategory category, java.lang.String country, java.lang.String state, java.lang.String city, java.util.Locale locale) This returns all businesses in a specified category and a specified city.
YPBusiness[]	getBusinessesInCorridor(java.lang.String businessName, Point[] corridor, double metersRadius, java.util.Locale locale) This returns all businesses matching a specified name in a specified corridor.
YPBusiness[]	getBusinessesInCorridor(java.lang.String businessName, YPCategory category, Point[] corridor, double metersRadius, java.util.Locale locale) This returns all businesses conforming to a specified name, category and corridor.
YPBusiness[]	getBusinessesInCorridor(YPCategory category, Point[] corridor, double metersRadius, java.util.Locale locale) This returns all businesses in a specified category and corridor.
YPBusiness[]	getBusinessesInPCode(java.lang.String businessName, java.lang.String country, java.lang.String postalCode, java.util.Locale locale) This returns all businesses matching a specified name in a specified postal code.
YPBusiness[]	getBusinessesInPCode(java.lang.String businessName, YPCategory category, java.lang.String country, java.lang.String postalCode, java.util.Locale locale) This returns all businesses conforming to a specified name, category and postal code.
YPBusiness[]	getBusinessesInPCode(YPCategory category, java.lang.String country, java.lang.String postalCode, java.util.Locale locale) This returns all businesses in a specified category and a specified postal code.
YPBusiness[]	getBusinessesInRadius(java.lang.String businessName, Point location, double metersRadius, java.util.Locale locale) This returns all businesses matching a specified name in a specified radius.
YPBusiness[]	getBusinessesInRadius(java.lang.String businessName, YPCategory category, Point location, double metersRadius, java.util.Locale locale) This returns all businesses conforming to a specified name, category, center point and radius.
YPBusiness[]	getBusinessesInRadius(YPCategory category, Point location, double metersRadius, java.util.Locale locale) This returns all businesses in a specified category and a specified radius.
YPBusiness[]	getBusinessesInSameCity(java.lang.String businessName, Location loc, java.util.Locale locale) Deprecated.
YPBusiness[]	getBusinessesInSameCity(java.lang.String businessName, YPCategory category, Location loc, java.util.Locale locale) Deprecated.
YPBusiness[]	getBusinessesInSameCity(YPCategory category, Location loc, java.util.Locale locale) Deprecated.
YPBusiness[]	getBusinessesInSamePCode(java.lang.String businessName, Location loc, java.util.Locale locale) Deprecated.
YPBusiness[]	getBusinessesInSamePCode(java.lang.String businessName, YPCategory category, Location loc, java.util.Locale locale) Deprecated.
YPBusiness[]	getBusinessesInSamePCode(YPCategory category, Location loc, java.util.Locale locale) Deprecated.
YPBusiness[]	getBusinessesInSameState(java.lang.String businessName, Location loc, java.util.Locale locale) Deprecated.
YPBusiness[]	getBusinessesInSameState(java.lang.String businessName, YPCategory category, Location loc, java.util.Locale locale) Deprecated.
YPBusiness[]	getBusinessesInSameState(YPCategory category, Location loc, java.util.Locale locale) Deprecated.
YPBusiness[]	getBusinessesInState(java.lang.String businessName, java.lang.String country, java.lang.String state, java.util.Locale locale) This returns all businesses matching a specified name in a specified state.
YPBusiness[]	getBusinessesInState(java.lang.String businessName, YPCategory category, java.lang.String country, java.lang.String state, java.util.Locale locale) This returns all businesses conforming to a specified name, category and state.
YPBusiness[]	getBusinessesInState(YPCategory category, java.lang.String country, java.lang.String state, java.util.Locale locale) This returns all businesses in a specified category and a specified state.
YPBusiness[]	getKeywordRelatedBusinessesInCity(java.lang.String keyword, java.lang.String country, java.lang.String state, java.lang.String city, java.util.Locale locale) This returns all businesses matching a specified keyword in a specified city.
YPBusiness[]	getKeywordRelatedBusinessesInCorridor(java.lang.String keyword, Point[] corridor, double metersRadius, java.util.Locale locale) This returns all businesses matching a specified keyword in a specified corridor.
YPBusiness[]	getKeywordRelatedBusinessesInPCode(java.lang.String keyword, java.lang.String country, java.lang.String postalCode, java.util.Locale locale) This returns all businesses matching a specified keyword in a specified postal code.
YPBusiness[]	getKeywordRelatedBusinessesInRadius(java.lang.String keyword, Point location, double metersRadius, java.util.Locale locale) This returns all businesses matching a specified keyword in a specified radius.
YPBusiness[]	getKeywordRelatedBusinessesInState(java.lang.String keyword, java.lang.String country, java.lang.String state, java.util.Locale locale) This returns all businesses matching a specified keyword in a specified state.
YPBusiness[]	getNearestNBusinesses(java.lang.String businessName, Point location, int n, java.util.Locale locale) This returns the N businesses closest to a given center point.
YPBusiness[]	getNearestNBusinesses(java.lang.String businessName, YPCategory category, Point location, int n, java.util.Locale locale) This returns the N businesses closest to a given center point.
YPBusiness[]	getNearestNBusinesses(YPCategory category, Point location, int n, java.util.Locale locale) This returns the N businesses closest to a given center point.
YPBusiness[]	getNearestNKeywordRelatedBusinesses(java.lang.String keyword, Point location, int n, java.util.Locale locale) This returns the N businesses closest to a given center point.
java.lang.String	xmlYP(org.w3c.dom.Document xmlRequest) This function performs geocoding based on an XML request (eLocation XML).

Method Detail

anyBusinessesInCity

public java.lang.Boolean anyBusinessesInCity(YPCategory category,
                                             java.lang.String country,
                                             java.lang.String state,
                                             java.lang.String city)

Deprecated.

This returns whether there are any businesses of this category in a specified city. Calling this function can avoid walking further down in the customized local hierarchy if none of the leafs contain businesses in the specified location. On the other hand, the overhead of accessing the external provider is incurred. If this function is nevver called, the provider is only accessed once (for a leaf of the hierarchy). If this function is always called, the provider is accessed for every single hierarchy on a path from the root to a leaf. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

category - a YPCategory object representing the category (must not be null)

country - a String representing the country (must not be null)

state - a String representing the state (must not be null)

city - a String representing the city (must not be null)

Returns:

A Boolean representing whether there are any businesses of this category in the specified city. If null is returned, none of the external providers support the request without running the actual query for a category. It is then unknown whether any businesses will be found in a full query

anyBusinessesInState

public java.lang.Boolean anyBusinessesInState(YPCategory category,
                                              java.lang.String country,
                                              java.lang.String state)

Deprecated.

This returns whether there are any businesses of this category in a specified state. Calling this function can avoid walking further down in the customized local hierarchy if none of the leafs contain businesses in the specified location. On the other hand, the overhead of accessing the external provider is incurred. If this function is nevver called, the provider is only accessed once (for a leaf of the hierarchy). If this function is always called, the provider is accessed for every single hierarchy on a path from the root to a leaf. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

category - a YPCategory object representing the category (must not be null)

country - a String representing the country (must not be null)

state - a String representing the state (must not be null)

Returns:

A Boolean representing whether there are any businesses of this category in the specified state. If null is returned, none of the external providers support the request without running the actual query for a category. It is then unknown whether any businesses will be found in a full query

anyBusinessesInPCode

public java.lang.Boolean anyBusinessesInPCode(YPCategory category,
                                              java.lang.String country,
                                              java.lang.String postalCode)

Deprecated.

This returns whether there are any businesses of this category in a specified postal code. Calling this function can avoid walking further down in the customized local hierarchy if none of the leafs contain businesses in the specified location. On the other hand, the overhead of accessing the external provider is incurred. If this function is nevver called, the provider is only accessed once (for a leaf of the hierarchy). If this function is always called, the provider is accessed for every single hierarchy on a path from the root to a leaf. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

category - a YPCategory object representing the category (must not be null)

country - a String representing the country (must not be null)

postalCode - a String representing the postal code (must not be null)

Returns:

A Boolean representing whether there are any businesses of this category in the specified postal code. If null is returned, none of the external providers support the request without running the actual query for a category. It is then unknown whether any businesses will be found in a full query

anyBusinessesInRadius

public java.lang.Boolean anyBusinessesInRadius(YPCategory category,
Point location,
                                               double metersRadius)

Deprecated.

This returns whether there are any businesses of this category in a specified radius. Calling this function can avoid walking further down in the customized local hierarchy if none of the leafs contain businesses in the specified location. On the other hand, the overhead of accessing the external provider is incurred. If this function is nevver called, the provider is only accessed once (for a leaf of the hierarchy). If this function is always called, the provider is accessed for every single hierarchy on a path from the root to a leaf. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

category - a YPCategory object representing the category (must not be null)

location - a PointImpl representing the center point of the circle (must not be null)

metersRadius - a double representing the radius in meters (must not be null)

Returns:

A Boolean representing whether there are any businesses of this category in the specified radius. If null is returned, none of the external providers support the request without running the actual query for a category. It is then unknown whether any businesses will be found in a full query

getBusinessesInCity

public YPBusiness[] getBusinessesInCity(java.lang.String businessName,
                                        java.lang.String country,
                                        java.lang.String state,
                                        java.lang.String city,
                                        java.util.Locale locale)

This returns all businesses matching a specified name in a specified city. This function MUST be implemented by each provider proxy. It is part of the required core functionality. Any provider not supporting this function might have serious restrictions in supporting any reasonable application. At the very least, such a "lacking" provider proxy could not be used as a "primary" provider. However, fail-over guarantees that applications would work if this function is covered by at least one provider proxy.

Parameters:

businessName - a String representing the business name (must not be null)

country - a String representing the country (must not be null)

state - a String representing the state (must not be null)

city - a String representing the city (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInState

public YPBusiness[] getBusinessesInState(java.lang.String businessName,
                                         java.lang.String country,
                                         java.lang.String state,
                                         java.util.Locale locale)

This returns all businesses matching a specified name in a specified state. This function MUST be implemented by each provider proxy. It is part of the required core functionality. Any provider not supporting this function might have serious restrictions in supporting any reasonable application. At the very least, such a "lacking" provider proxy could not be used as a "primary" provider. However, fail-over guarantees that applications would work if this function is covered by at least one provider proxy.

Parameters:

businessName - a String representing the business name (must not be null)

country - a String representing the country (must not be null)

state - a String representing the state (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInRadius

public YPBusiness[] getBusinessesInRadius(java.lang.String businessName,
Point location,
                                          double metersRadius,
                                          java.util.Locale locale)

This returns all businesses matching a specified name in a specified radius. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

businessName - a String representing the business name (must not be null)

location - a PointImpl representing the center of the circle (must not be null)

metersRadius - a double representing the radius in meters (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInPCode

public YPBusiness[] getBusinessesInPCode(java.lang.String businessName,
                                         java.lang.String country,
                                         java.lang.String postalCode,
                                         java.util.Locale locale)

This returns all businesses matching a specified name in a specified postal code. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

businessName - a String representing the business name (must not be null)

country - a String representing the country (must not be null)

postalCode - a String representing the postal code (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInCity

public YPBusiness[] getBusinessesInCity(YPCategory category,
                                        java.lang.String country,
                                        java.lang.String state,
                                        java.lang.String city,
                                        java.util.Locale locale)

This returns all businesses in a specified category and a specified city. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

category - a YPCategory object representing the requested category (must not be null)

country - a String representing the country (must not be null)

state - a String representing the state (must not be null)

city - a String representing the city (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInState

public YPBusiness[] getBusinessesInState(YPCategory category,
                                         java.lang.String country,
                                         java.lang.String state,
                                         java.util.Locale locale)

This returns all businesses in a specified category and a specified state. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

category - a YPCategory object representing the requested category (must not be null)

country - a String representing the country (must not be null)

state - a String representing the state (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInRadius

public YPBusiness[] getBusinessesInRadius(YPCategory category,
Point location,
                                          double metersRadius,
                                          java.util.Locale locale)

This returns all businesses in a specified category and a specified radius. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

category - a YPCategory object representing the requested category (must not be null)

location - a PointImpl representing the center of the circle (must not be null)

metersRadius - a double representing the radius in meters (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInPCode

public YPBusiness[] getBusinessesInPCode(YPCategory category,
                                         java.lang.String country,
                                         java.lang.String postalCode,
                                         java.util.Locale locale)

This returns all businesses in a specified category and a specified postal code. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

category - a YPCategory object representing the requested category (must not be null)

country - a String representing the country (must not be null)

postalCode - a String representing the postal code (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

anyBusinessesInSameCity

public java.lang.Boolean anyBusinessesInSameCity(YPCategory category,
Location loc)

Deprecated.

This function determines whether there are any businesses known in a specified category and city. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

category - a YPCategory representing the category in which businesses are queried

loc - a Location that serves to determine the city in which businesses are queried

Returns:

a Boolean representing whether any business was found. Null is returned if this function is not available.

anyBusinessesInSameState

public java.lang.Boolean anyBusinessesInSameState(YPCategory category,
Location loc)

Deprecated.

This function determines whether there are any businesses known in a specified category and state. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

category - a YPCategory representing the category in which businesses are queried

loc - a Location that serves to determine the state in which businesses are queried

Returns:

a Boolean representing whether any business was found. Null is returned if this function is not available.

anyBusinessesInSamePCode

public java.lang.Boolean anyBusinessesInSamePCode(YPCategory category,
Location loc)

Deprecated.

This function determines whether there are any businesses known in a specified category and postal code. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

category - a YPCategory representing the category in which businesses are queried

loc - a Location that serves to determine the postal code in which businesses are queried

Returns:

a Boolean representing whether any business was found. Null is returned if this function is not available.

getBusinessesInSameCity

public YPBusiness[] getBusinessesInSameCity(java.lang.String businessName,
Location loc,
                                            java.util.Locale locale)

Deprecated.

This function determines the businesses known matching a specified name and city. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the name of businesses that are queried

loc - a Location that serves to determine the city in which businesses are queried

locale - a Locale that can affect preferences, such as language settings

Returns:

an array of YPBusiness representing the businesses found

getBusinessesInSameState

public YPBusiness[] getBusinessesInSameState(java.lang.String businessName,
Location loc,
                                             java.util.Locale locale)

Deprecated.

This function determines the businesses known matching a specified name and state. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the name of businesses that are queried

loc - a Location that serves to determine the state in which businesses are queried

locale - a Locale that can affect preferences, such as language settings

Returns:

an array of YPBusiness representing the businesses found

getBusinessesInSamePCode

public YPBusiness[] getBusinessesInSamePCode(java.lang.String businessName,
Location loc,
                                             java.util.Locale locale)

Deprecated.

This function determines the businesses known matching a specified name and postal code. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the name of businesses that are queried

loc - a Location that serves to determine the postal code in which businesses are queried

locale - a Locale that can affect preferences, such as language settings

Returns:

an array of YPBusiness representing the businesses found

getBusinessesInSameCity

public YPBusiness[] getBusinessesInSameCity(YPCategory category,
Location loc,
                                            java.util.Locale locale)

Deprecated.

This function determines the businesses known in a specified category and city. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

category - a YPCategory representing the category in which businesses are queried

loc - a Location that serves to determine the city in which businesses are queried

locale - a Locale that can affect preferences, such as language settings

Returns:

an array of YPBusiness representing the businesses found

getBusinessesInSameState

public YPBusiness[] getBusinessesInSameState(YPCategory category,
Location loc,
                                             java.util.Locale locale)

Deprecated.

This function determines the businesses known in a specified category and state. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

category - a YPCategory representing the category in which businesses are queried

loc - a Location that serves to determine the state in which businesses are queried

locale - a Locale that can affect preferences, such as language settings

Returns:

an array of YPBusiness representing the businesses found

getBusinessesInSamePCode

public YPBusiness[] getBusinessesInSamePCode(YPCategory category,
Location loc,
                                             java.util.Locale locale)

Deprecated.

This function determines the businesses known in a specified category and postal code. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

category - a YPCategory representing the category in which businesses are queried

loc - a Location that serves to determine the postal code in which businesses are queried

locale - a Locale that can affect preferences, such as language settings

Returns:

an array of YPBusiness representing the businesses found

getBusinessesInSameCity

public YPBusiness[] getBusinessesInSameCity(java.lang.String businessName,
YPCategory category,
Location loc,
                                            java.util.Locale locale)

Deprecated.

This function determines the businesses known in a specified category and city. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the name of businesses that are queried

category - a YPCategory representing the category in which businesses are queried

loc - a Location that serves to determine the city in which businesses are queried

locale - a Locale that can affect preferences, such as language settings

Returns:

an array of YPBusiness representing the businesses found

getBusinessesInSameState

public YPBusiness[] getBusinessesInSameState(java.lang.String businessName,
YPCategory category,
Location loc,
                                             java.util.Locale locale)

Deprecated.

This function determines the businesses known in a specified category and state. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the name of businesses that are queried

category - a YPCategory representing the category in which businesses are queried

loc - a Location that serves to determine the state in which businesses are queried

locale - a Locale that can affect preferences, such as language settings

Returns:

an array of YPBusiness representing the businesses found

getBusinessesInSamePCode

public YPBusiness[] getBusinessesInSamePCode(java.lang.String businessName,
YPCategory category,
Location loc,
                                             java.util.Locale locale)

Deprecated.

This function determines the businesses known in a specified category and postal code. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the name of businesses that are queried

category - a YPCategory representing the category in which businesses are queried

loc - a Location that serves to determine the postal code in which businesses are queried

locale - a Locale that can affect preferences, such as language settings

Returns:

an array of YPBusiness representing the businesses found

getBusinessesInCity

public YPBusiness[] getBusinessesInCity(java.lang.String businessName,
YPCategory category,
                                        java.lang.String country,
                                        java.lang.String state,
                                        java.lang.String city,
                                        java.util.Locale locale)

This returns all businesses conforming to a specified name, category and city. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the business name (must not be null)

category - a YPCategory object representing the requested category (must not be null)

country - a String representing the country (must not be null)

state - a String representing the state (must not be null)

city - a String representing the city (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInState

public YPBusiness[] getBusinessesInState(java.lang.String businessName,
YPCategory category,
                                         java.lang.String country,
                                         java.lang.String state,
                                         java.util.Locale locale)

This returns all businesses conforming to a specified name, category and state. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the business name (must not be null)

category - a YPCategory object representing the requested category (must not be null)

country - a String representing the country (must not be null)

state - a String representing the state (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInRadius

public YPBusiness[] getBusinessesInRadius(java.lang.String businessName,
YPCategory category,
Point location,
                                          double metersRadius,
                                          java.util.Locale locale)

This returns all businesses conforming to a specified name, category, center point and radius. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the business name (must not be null)

category - a YPCategory object representing the requested category (must not be null)

location - a PointImpl representing the center of the circle (must not be null)

metersRadius - a double representing the radius in meters (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInPCode

public YPBusiness[] getBusinessesInPCode(java.lang.String businessName,
YPCategory category,
                                         java.lang.String country,
                                         java.lang.String postalCode,
                                         java.util.Locale locale)

This returns all businesses conforming to a specified name, category and postal code. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the business name (must not be null)

category - a YPCategory object representing the requested category (must not be null)

country - a String representing the country (must not be null)

postalCode - a String representing the postal code (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getNearestNBusinesses

public YPBusiness[] getNearestNBusinesses(java.lang.String businessName,
Point location,
                                          int n,
                                          java.util.Locale locale)

This returns the N businesses closest to a given center point. The businesses have to conform to a given name. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

businessName - a String representing the business name (must not be null)

location - a Point representing the center point of the query (must not be null)

n - an int representing the number of businesses ("closest N")

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getNearestNBusinesses

public YPBusiness[] getNearestNBusinesses(YPCategory category,
Point location,
                                          int n,
                                          java.util.Locale locale)

This returns the N businesses closest to a given center point. The businesses have to conform to a given category. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

category - a YPCategory object representing the requested category (must not be null)

location - a Point representing the center point of the query (must not be null)

n - an int representing the number of businesses ("closest N")

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getNearestNBusinesses

public YPBusiness[] getNearestNBusinesses(java.lang.String businessName,
YPCategory category,
Point location,
                                          int n,
                                          java.util.Locale locale)

This returns the N businesses closest to a given center point. The businesses have to conform to a given name and category. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the business name (must not be null)

category - a YPCategory object representing the requested category (must not be null)

location - a Point representing the center point of the query (must not be null)

n - an int representing the number of businesses ("closest N")

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

xmlYP

public java.lang.String xmlYP(org.w3c.dom.Document xmlRequest)

This function performs geocoding based on an XML request (eLocation XML). This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

xmlRequest - a Document object representing the XMl document of the yp request.

Returns:

a String representing the XMl String of the yp response.

getBusinessesInCorridor

public YPBusiness[] getBusinessesInCorridor(java.lang.String businessName,
Point[] corridor,
                                            double metersRadius,
                                            java.util.Locale locale)

This returns all businesses matching a specified name in a specified corridor. A corridor is the area within a specified maximum distance around a route. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

businessName - a String representing the business name (must not be null)

corridor - an array of Point representing the corridor (must not be null)

metersRadius - a double representing the radius in meters (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInCorridor

public YPBusiness[] getBusinessesInCorridor(java.lang.String businessName,
YPCategory category,
Point[] corridor,
                                            double metersRadius,
                                            java.util.Locale locale)

This returns all businesses conforming to a specified name, category and corridor. A corridor is the area within a specified maximum distance around a route. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

businessName - a String representing the business name (must not be null)

category - a YPCategory object representing the requested category (must not be null)

corridor - an array of Point representing the corridor (must not be null)

metersRadius - a double representing the radius in meters (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesInCorridor

public YPBusiness[] getBusinessesInCorridor(YPCategory category,
Point[] corridor,
                                            double metersRadius,
                                            java.util.Locale locale)

This returns all businesses in a specified category and corridor. A corridor is the area within a specified maximum distance around a route. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

category - a YPCategory object representing the requested category (must not be null)

corridor - an array of Point representing the corridor (must not be null)

metersRadius - a double representing the radius in meters (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesAnywhere

public YPBusiness[] getBusinessesAnywhere(java.lang.String businessName,
                                          java.util.Locale locale)

This returns all businesses matching a specified name.

Parameters:

businessName - a String representing the business name (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesAnywhere

public YPBusiness[] getBusinessesAnywhere(java.lang.String businessName,
YPCategory category,
                                          java.util.Locale locale)

This returns all businesses conforming to a specified name and category.

Parameters:

businessName - a String representing the business name (must not be null)

category - a YPCategory object representing the requested category (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getBusinessesAnywhere

public YPBusiness[] getBusinessesAnywhere(YPCategory category,
                                          java.util.Locale locale)

This returns all businesses in a specified category.

Parameters:

category - a YPCategory object representing the requested category (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getKeywordRelatedBusinessesInCity

public YPBusiness[] getKeywordRelatedBusinessesInCity(java.lang.String keyword,
                                                      java.lang.String country,
                                                      java.lang.String state,
                                                      java.lang.String city,
                                                      java.util.Locale locale)

This returns all businesses matching a specified keyword in a specified city. A keyword is specified and businesses are searched with that keyword either in the business name or in the business category. This operation might take long if there are many categories with the specified keyword. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

keyword - a String representing a keyword that might be either in a business name or a category (must not be null)

country - a String representing the country (must not be null)

state - a String representing the state (must not be null)

city - a String representing the city (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getKeywordRelatedBusinessesInState

public YPBusiness[] getKeywordRelatedBusinessesInState(java.lang.String keyword,
                                                       java.lang.String country,
                                                       java.lang.String state,
                                                       java.util.Locale locale)

This returns all businesses matching a specified keyword in a specified state. A keyword is specified and businesses are searched with that keyword either in the business name or in the business category. This operation might take long if there are many categories with the specified keyword. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

keyword - a String representing a keyword that might be either in a business name or a category (must not be null)

country - a String representing the country (must not be null)

state - a String representing the state (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getKeywordRelatedBusinessesInRadius

public YPBusiness[] getKeywordRelatedBusinessesInRadius(java.lang.String keyword,
Point location,
                                                        double metersRadius,
                                                        java.util.Locale locale)

This returns all businesses matching a specified keyword in a specified radius. A keyword is specified and businesses are searched with that keyword either in the business name or in the business category. This operation might take long if there are many categories with the specified keyword. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

keyword - a String representing a keyword that might be either in a business name or a category (must not be null)

location - a Point representing the center of the circle (must not be null)

metersRadius - a double representing the radius in meters (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getKeywordRelatedBusinessesInCorridor

public YPBusiness[] getKeywordRelatedBusinessesInCorridor(java.lang.String keyword,
Point[] corridor,
                                                          double metersRadius,
                                                          java.util.Locale locale)

This returns all businesses matching a specified keyword in a specified corridor. A keyword is specified and businesses are searched with that keyword either in the business name or in the business category. This operation might take long if there are many categories with the specified keyword. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

keyword - a String representing a keyword that might be either in a business name or a category (must not be null)

corridor - an array of Point representing the corridor (must not be null)

metersRadius - a double representing the radius / half width of corridor in meters (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getKeywordRelatedBusinessesInPCode

public YPBusiness[] getKeywordRelatedBusinessesInPCode(java.lang.String keyword,
                                                       java.lang.String country,
                                                       java.lang.String postalCode,
                                                       java.util.Locale locale)

This returns all businesses matching a specified keyword in a specified postal code. A keyword is specified and businesses are searched with that keyword either in the business name or in the business category. This operation might take long if there are many categories with the specified keyword. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

keyword - a String representing a keyword that might be either in a business name or a category (must not be null)

country - a String representing the country (must not be null)

postalCode - a String representing the postal code (must not be null)

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses

getNearestNKeywordRelatedBusinesses

public YPBusiness[] getNearestNKeywordRelatedBusinesses(java.lang.String keyword,
Point location,
                                                        int n,
                                                        java.util.Locale locale)

This returns the N businesses closest to a given center point. The businesses have to match a given keyword. A keyword is specified and businesses are searched with that keyword either in the business name or in the business category. This operation might take long if there are many categories with the specified keyword. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

keyword - a String representing a keyword that might be either in a business name or a category (must not be null)

location - a Point representing the center point of the query (must not be null)

n - an int representing the number of businesses ("closest N")

locale - a Locale object that can affect language, measures of distance, ... (may be null)

Returns:

an array of YPBusiness objects representing all found businesses