info.aduna.gee.spectacle.gee
Class Navigation

java.lang.Object
  info.aduna.gee.spectacle.gee.Navigation

public class Navigation
extends Object

The Navigation object is used between remote API clients and the server only. Application builders should never use this class. A Navigation object is capable to serialize itself efficiently. All actions that should be performed by the server on reception of the serialization, or on loading the serialization from disk, are handled by the static "create()" method.

Constructor Summary

Navigation()
Required for Jazzz

Navigation(NavigationSpecification navSpec, JitSectionRenderer renderer, String contentChannelName)
Construct a fully specified navigation object.

Method Summary

static void	create(String serverPath, String channelName, String password, String xml) Take all actions (on the server only!) to effectuate a serialized navigation.
String	getContentChannelName()
NavigationSpecification	getNavigationSpecification()
JitSectionRenderer	getSectionRenderer()
String	toXML()
String	toXML(String pathToJazzzDefinition) You should use this function if-and-only-if you want to serialize a JitSectionRenderer, different from DefaultJitSectionRenderer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Navigation

public Navigation()

Required for Jazzz

Navigation

public Navigation(NavigationSpecification navSpec,
                  JitSectionRenderer renderer,
                  String contentChannelName)

Construct a fully specified navigation object.

Parameters:

navSpec - the navigation specification

renderer - the renderer -- someone should know how to realize the navigation specification

contentChannelName - the name of the channel that contains the set of objects you're browsing through

Method Detail

create

public static void create(String serverPath,
                          String channelName,
                          String password,
                          String xml)

Take all actions (on the server only!) to effectuate a serialized navigation.

Parameters:

serverPath - the current server path, e.g "https://www.mysecurehost.com:9899"

channelName - the name of the channel that is 'doing' the navigation

password - the password of that channel

xml - the serialized navigation

toXML

public String toXML()
             throws IOException

Returns:

the serialization using the default Jazzz definitions.

Throws:

IOException

toXML

public String toXML(String pathToJazzzDefinition)
             throws IOException

You should use this function if-and-only-if you want to serialize a JitSectionRenderer, different from DefaultJitSectionRenderer. If you do, take care to add the Jazzz specification of this new JitSectionRenderer implementation to the default Jazzz definitions and store it somewhere in your class path.

Parameters:

pathToJazzzDefinition - the path (in your classpath) of all required Jazzz definitions.

Returns:

the serialization

Throws:

IOException

getNavigationSpecification

public NavigationSpecification getNavigationSpecification()

getSectionRenderer

public JitSectionRenderer getSectionRenderer()

getContentChannelName

public String getContentChannelName()