oracle.jbo.common
Class CategoryManagerImpl

java.lang.Object
  oracle.jbo.common.CategoryManagerImpl

All Implemented Interfaces:

CategoryManager

Direct Known Subclasses:

ClientCategoryManager, ViewObjectCategoryManagerImpl

public class CategoryManagerImpl
extends java.lang.Object
implements CategoryManager

Field Summary

protected java.util.LinkedHashMap<java.lang.String,Category>	mCategories
protected CategoryManagerOwner	mOwner

Constructor Summary

CategoryManagerImpl()
Internal use only.

CategoryManagerImpl(CategoryManagerOwner owner)
Internal use only.

CategoryManagerImpl(CategoryManagerOwner owner, CategoryManager defCategoryMrg)
Internal use only.

CategoryManagerImpl(CategoryManagerOwner owner, CategoryManager defCategoryMrg, int size)
Internal use only.

CategoryManagerImpl(int size)
Internal use only.

Method Summary

void	addCategory(Category category) Internal use only.
void	clearCategories() Internal use only.
Category	findCategory(java.lang.String categoryName) Internal use only.
java.util.List<Category>	getAllCategories() Internal use only.
java.util.Map	getAllCategoriesLookupMap() Internal use only.
protected java.util.Map	getCategoriesMap() Internal use only.
Category	getCategory(java.lang.String categoryName) Internal use only.
java.util.List<Category>	getDeclaredCategories() Internal use only.
Category	getDefaultCategory() Internal use only.
java.lang.String	getName() Internal use only.
java.util.List<Category>	getOrderedCategories(boolean includeDefaultCategory, Category.CategoryType categoryType, LocaleContext locale) Internal Framework use only.
CategoryManagerOwner	getOwner() Internal use only.
CategoryManager	getParentCategoryManager() Internal use only.
boolean	hasCategories() Internal use only.
void	loadFromXML(DefElement[] xmlElements) *** For internal framework use only ***
Category	lookupCategory(java.lang.String categoryName) Internal use only.
Category	removeCategory(java.lang.String categoryName) Internal use only.

Methods inherited from class java.lang.Object

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

Field Detail

mCategories

protected java.util.LinkedHashMap<java.lang.String,Category> mCategories

mOwner

protected CategoryManagerOwner mOwner

Constructor Detail

CategoryManagerImpl

public CategoryManagerImpl()

Internal use only.

CategoryManagerImpl

public CategoryManagerImpl(int size)

Internal use only.

CategoryManagerImpl

public CategoryManagerImpl(CategoryManagerOwner owner)

Internal use only.

CategoryManagerImpl

public CategoryManagerImpl(CategoryManagerOwner owner,
                           CategoryManager defCategoryMrg)

Internal use only.

CategoryManagerImpl

public CategoryManagerImpl(CategoryManagerOwner owner,
                           CategoryManager defCategoryMrg,
                           int size)

Internal use only.

Method Detail

getOwner

public CategoryManagerOwner getOwner()

Internal use only.

Specified by:

getOwner in interface CategoryManager

Returns:

gives the Owner of this CategroyManager

getCategoriesMap

protected java.util.Map getCategoriesMap()

Internal use only.

getAllCategoriesLookupMap

public java.util.Map getAllCategoriesLookupMap()

Internal use only.

Specified by:

getAllCategoriesLookupMap in interface CategoryManager

Returns:

return a readonly lookup map that can be used to find categories via get method.

getAllCategories

public java.util.List<Category> getAllCategories()

Internal use only.

Specified by:

getAllCategories in interface CategoryManager

Returns:

return the Array of all Categories. This will include the categories from Parents managers also

getParentCategoryManager

public CategoryManager getParentCategoryManager()

Internal use only.

getDefaultCategory

public Category getDefaultCategory()

Internal use only.

Specified by:

getDefaultCategory in interface CategoryManager

Returns:

the default Category

addCategory

public void addCategory(Category category)

Internal use only.

Specified by:

addCategory in interface CategoryManager

Parameters:

category - Register a new Category with CategoryManager

removeCategory

public Category removeCategory(java.lang.String categoryName)

Internal use only.

Specified by:

removeCategory in interface CategoryManager

Parameters:

categoryName - Remove the Category from CategoryManager

loadFromXML

public void loadFromXML(DefElement[] xmlElements)

*** For internal framework use only ***

hasCategories

public boolean hasCategories()

Internal use only.

Specified by:

hasCategories in interface CategoryManager

Returns:

return true if Manager has one or more category

getDeclaredCategories

public java.util.List<Category> getDeclaredCategories()

Internal use only.

getCategory

public Category getCategory(java.lang.String categoryName)

Internal use only.

Specified by:

getCategory in interface CategoryManager

Returns:

return the Category whose name is categoryName This API will throw NoDefException exception if category not found

findCategory

public Category findCategory(java.lang.String categoryName)

Internal use only.

Specified by:

findCategory in interface CategoryManager

Returns:

return the Category whose name is categoryName or null if category not found

getName

public java.lang.String getName()

Internal use only.

lookupCategory

public Category lookupCategory(java.lang.String categoryName)

Internal use only.

Specified by:

lookupCategory in interface CategoryManager

clearCategories

public void clearCategories()

Internal use only.

getOrderedCategories

public java.util.List<Category> getOrderedCategories(boolean includeDefaultCategory,
                                                     Category.CategoryType categoryType,
                                                     LocaleContext locale)

Internal Framework use only.

Specified by:

getOrderedCategories in interface CategoryManager

Parameters:

includeDefaultCategory - - If the value is true, then the default category for this View object ( or view def ) is included in the list of the categories that returned. If the value is false, the default category is excluded from the list.

categoryType - - this flag tells what type of categories should the return list contains. If the value is "null", then return list will contain all type of categories. This value should be of enum type Category.CategoryType

locale -

Returns:

will return a list contains Categories arranged by their FieldOrder