com.endeca.infront.navigation

Interface NavigationStateBuilder

All Known Implementing Classes:

UrlNavigationStateBuilder

public interface NavigationStateBuilder

A builder used by the core cartridge handlers to create NavigationState and RecordState objects.

NavigationState and RecordState objects can be serialized to strings by calling NavigationState#toString() and RecordState#toString(), respectively. The exact format of this serialization depends on the specific NavigationStateBuilder implementation and the way in which it is configured.

Implementing classes must not keep state between calls because multiple threads may access a builder instance at the same time. It is also important not to modify any arguments passed into the builder.

Method Summary

Methods

Modifier and Type	Method and Description
NavigationState	parseNavigationState(String queryString, String pathInfo, String characterEncoding) Create a NavigationState parsed from a query string, a path info, and a character encoding.
RecordState	parseRecordState(String queryString, String pathInfo, String characterEncoding) Create a RecordState parsed from a path info, a query string, and a character encoding.

Method Detail

parseNavigationState

NavigationState parseNavigationState(String queryString,
                                   String pathInfo,
                                   String characterEncoding)
                                     throws NavigationException

Create a NavigationState parsed from a query string, a path info, and a character encoding. Depending on the NavigationStateBuilder implementation and the way in which it is configured, the navigation state may be described by the query string, the path info, or some combination of the two.

Parameters:

queryString - The query string that describes the NavigationState

pathInfo - The path info that describes the NavigationState

characterEncoding - The character encoding of the path info and query string

Returns:

a NavigationState constructed from the query string and path info

Throws:

NavigationException - if a NavigationState could not be constructed from the given query string and path info

parseRecordState

RecordState parseRecordState(String queryString,
                           String pathInfo,
                           String characterEncoding)
                             throws NavigationException

Create a RecordState parsed from a path info, a query string, and a character encoding. Depending on the NavigationStateBuilder implementation and the way in which it is configured, the record state may be described by the query string, the path info, or some combination of the two.

Parameters:

queryString - The query string that describes the RecordState

pathInfo - The path info that describes the RecordState

characterEncoding - The character encoding of the path info and query string

Returns:

a RecordState constructed from the query string and path info

Throws:

NavigationException - if a RecordState could not be constructed from the given query string and path info