createViewNavFromCategory (View - Java™)

Creates a view navigator for all entries in a view under a specified category.

Defined in

View

Syntax

public ViewNavigator createViewNavFromCategory(String categoryName)
    throws NotesException
public ViewNavigator createViewNavFromCategory(String categoryName, int cacheSize)
    throws NotesException

Parameters

String categoryName

The name of a category in the view.

int cacheSize

The size of the navigator cache in view entries. Legal values are 0 (no cache) through 128 (default). Applies only to remote (IIOP) operations.

Return value


ViewNavigator

The new view navigator.

Usage

The entries in the navigator are all the entries in the view under the specified category. The category entry itself is excluded.

If the category does not exist, the result is an empty navigator. All navigation methods return null.

Subcategories can be specified using backslash notation (don't forget to escape the backslashes), for example, "Asia\\Korea" means the subcategory "Korea" under the main category "Asia."

The cache enhances performance for iterative processing of entries using the navigation methods that do not take a parameter.

Example