|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
YPCategory |
fromFullyQualifiedName(java.lang.String name) This retrieves a category from its fully qualified name (including names of supercategories). |
java.util.Vector |
getCategoriesByID(java.lang.String providerName, java.lang.String id) Returns a list of categories given the provider name and category ID |
YPCategory[] |
getCategoriesMatchingName(YPCategory rootOfSearch, java.lang.String pattern) This function returns the direct and indirect subcategories of a given category matching a given keyword. |
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) Returns the category given the provider name and category ID |
YPCategory |
getParentCategory(YPCategory category) This returns the parent-/supercategory of a given category. |
YPCategory[] |
getSubCategories(YPCategory category) This returns all subcategories of a given category. |
YPCategory |
getSubCategory(YPCategory category, java.lang.String name) This returns a category subcategory with a specified name. |
Method Detail |
public YPCategory fromFullyQualifiedName(java.lang.String name)
name
- a String representing the namepublic java.util.Vector getCategoriesByID(java.lang.String providerName, java.lang.String id)
providerName
- the name of the providerid
- the id of the categorypublic YPCategory[] getCategoriesMatchingName(YPCategory rootOfSearch, java.lang.String pattern)
rootOfSearch
- A YPCategory object representing the category where to start the search. Only (direct or indirect) subcategories will be searched.pattern
- a String representing a keyword to look forpublic YPCategory getCategoryAtPath(java.lang.String[] categoriesOnPath)
categoriesOnPath
- an array of String representing the names of categories along the path to the requested category (must not be null)public YPCategory getCategoryAtRoot()
public YPCategory getCategoryByID(java.lang.String providerName, java.lang.String id)
providerName
- the name of the providerid
- the id of the categorypublic YPCategory getParentCategory(YPCategory category)
category
- a YPCategory object representing the category for which to return the parentpublic YPCategory[] getSubCategories(YPCategory category)
category
- a YPCategory object representing the category for which to return the subcategoriespublic YPCategory getSubCategory(YPCategory category, java.lang.String name)
category
- a YPCategory object representing the category for which to return the subcategory
|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |