oracle.panama.spatial.yp
Interface YPFinder

All Superinterfaces:

YPFinderSimple

public interface YPFinder

extends YPFinderSimple

This interface defines a service object that can find businesses in a given area that match either a name or category. In contrast to YPFinderSimple, this interface also defines two functions that are independent from the external provider. They are thus only implemented in the managing class YPFinderImpl, not in the provider-specific classes YPFinderImplXXXXX. Any class implementing this interface should be thread-safe.

Method Summary

Type	Method
java.util.Vector	getCategoriesByID(java.lang.String providerName, java.lang.String id)
YPCategory	getCategoryAtPath(java.lang.String[] categoriesOnPath) This returns the category at the specified path from the root of the customized local hierarchy.
YPCategory	getCategoryAtRoot() This returns the category at the root of the customized local hierarchy.
YPCategory	getCategoryByID(java.lang.String providerName, java.lang.String id)
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[]	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[]	getNearestNKeywordRelatedBusinesses(java.lang.String keyword, Point location, int n, java.util.Locale locale) This returns the N businesses closest to a given center point.

Methods inherited from interface oracle.panama.spatial.yp.YPFinderSimple

anyBusinessesInCity, anyBusinessesInPCode, anyBusinessesInRadius, anyBusinessesInSameCity, anyBusinessesInSamePCode, anyBusinessesInSameState, anyBusinessesInState, getBusinessesAnywhere, getBusinessesAnywhere, getBusinessesAnywhere, getBusinessesInCity, getBusinessesInCity, getBusinessesInCity, getBusinessesInCorridor, getBusinessesInCorridor, getBusinessesInCorridor, getBusinessesInPCode, getBusinessesInPCode, getBusinessesInPCode, getBusinessesInRadius, getBusinessesInRadius, getBusinessesInRadius, getBusinessesInSameCity, getBusinessesInSameCity, getBusinessesInSameCity, getBusinessesInSamePCode, getBusinessesInSamePCode, getBusinessesInSamePCode, getBusinessesInSameState, getBusinessesInSameState, getBusinessesInSameState, getBusinessesInState, getBusinessesInState, getBusinessesInState, getNearestNBusinesses, getNearestNBusinesses, getNearestNBusinesses, xmlYP

Method Detail

getCategoryAtRoot

public YPCategory getCategoryAtRoot()

This returns the category at the root of the customized local hierarchy. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Returns:

a YPCategory object representing the category at the root of the hierarchy

getCategoryAtPath

public YPCategory getCategoryAtPath(java.lang.String[] categoriesOnPath)

This returns the category at the specified path from the root of the customized local hierarchy. This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

categoriesOnPath - an array of String representing the names of categories along the path to the requested category (must not be null)

Returns:

a YPCategory object representing the category at the specified path

getCategoryByID

public YPCategory getCategoryByID(java.lang.String providerName,
                                  java.lang.String id)

getCategoriesByID

public java.util.Vector getCategoriesByID(java.lang.String providerName,
                                          java.lang.String id)

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 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

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