info.aduna.gee.spectacle.gee
Class NavigationChannel

java.lang.Object
  info.aduna.gee.spectacle.webserver.Channel
      info.aduna.gee.spectacle.gee.NavigationChannel

All Implemented Interfaces:

EntryConstants, FileNames, ApiConstants, UserTypes

public class NavigationChannel
extends Channel

NavigationChannel represents just in time (jit) server navigation. Note that the server always just in time computes the contents of a section. However, normally all sections exist. But in case of jit server navigation, even the navigation itself (!) is computed just in time. Section are just in time created and only then, again on the fly, the contents are computed. The specification of the navigation is ... a NavigationSpecification object.

Field Summary

Fields inherited from class info.aduna.gee.spectacle.webserver.Channel

PRIVACY_BEST_FRIEND, PRIVACY_CLOSE_FRIEND, PRIVACY_FRIEND, PRIVACY_OWNER, PRIVACY_WORLD, SORT_BY_LABELS, SORT_BY_TEXT, SORT_BY_TYPES, SUBSCRIPTION_LABEL_ID

Fields inherited from interface info.aduna.gee.publication.servlets.ApiConstants

CREATE_EMAIL_KEY, CREATE_NAME_KEY, CREATE_PASSWORD_KEY, CREATE_TIMETOLIVE_KEY, MESSAGE_KEY, RESULT_KEY, RETURN_CODE_KEY

Fields inherited from interface info.aduna.gee.publication.content.EntryConstants

ACLS_PREFIX, AFTER_TRANSFER, APPLET_TYPE_VALUE, ASSOCIATES_EDIT_LEVEL, BEFORE_STORAGE, BEFORE_TRANSFER, CODE_KEY, CODEBASE_KEY, CONSTRUCTION_KEY, CONTAINER_TTL_KEY, CONTAINERID_KEY, CONTAINERPROPS_KEY, DBPRIVACY_LEVEL_KEY, DESCRIPTION_KEY, EMBED_TYPE_VALUE, END_TIME_KEY, ENTRY_ID_KEY, ENTRYATTRIBS_KEY, ENTRYPARAMS_KEY, ENTRYPROPS_KEY, EXPIRES_KEY, EXTERNAL_ENTRY_KEY, HEIGHT_KEY, HTML_KEY, HTML_TYPE_VALUE, ID2IDID_KEY, IMAGE_TYPE_VALUE, IMPORT_CLASSNAME, IMPORT_DONT_FORWARD, IMPORT_IMPORTED, IMPORT_LANGUAGE, IMPORT_SERVER_NAME, IMPORT_TYPE_VALUE, INFO_EXTENSION, INHERIT_CONFIGURATION, INLINE_DESCRIPTION_IS_HTML_KEY, INLINE_DESCRIPTION_KEY, INSPIRES_KEY, JIT_DESTINATION, JIT_DESTINATION_INDEX, LINK_IN_FRAME_KEY, LINK_KEY, MANUAL_KEY, MINIMALHEIGHT_KEY, MINIMALWIDTH_KEY, NAVIGATION_KEY, OBJECT_TYPE_VALUE, OCCURRING_CLABELS_KEY, OVERRIDE_SUGGESTION_KEY, PRIVACY_LEVEL_KEY, PROVIDE_KEY, PROVIDE_PL_KEY, QUALIFIED_BASE_KEY, RE_EXPORT_KEY, RE_MANUAL_KEY, REPEAT_ID_KEY, REPEAT_TODAY_KEY, REQUIRES_NEW_PAGE, ROTATABLE_KEY, SHARED_CLABELS_KEY, SHOP_GIF_KEY, SHOP_GIF_LOCATION_KEY, SHOP_ID_KEY, SHOP_ORIGIN_KEY, SHOP_OVER_GIF_KEY, SORT_CLABELS, SORT_DESCRIPTION, SOURCE_KEY, STARTSECTION_KEY, SUBSCRIBED_COLOR_KEY, SUBSCRIBED_GIF_KEY, SUBSCRIBED_GIF_LOCATION_KEY, SUBSCRIBED_OVER_GIF_KEY, SUBSCRIBED_VISIBLE_CLABELS_KEY, SUBSCRIPTION_KEY, SUBSCRIPTION_LINK_KEY, SUGGESTION_KEY, SUMMARY_IS_HTML_KEY, SUMMARY_KEY, SUMMARY_TYPE_VALUE, TEMPLATEPREFERENCES_KEY, TEXT_KEY, TEXT_TYPE_VALUE, TIME_KEY, TMPL_DESCRIPTOR_KEY, TMPL_FOREIGN_ID_KEY, TMPL_ID_KEY, TMPL_PREFERENCES_KEY, TMPL_STUB_RECOGNIZER_KEY, TMPLD_TYPE_VALUE, TYPE_KEY, WIDTH_KEY

Fields inherited from interface info.aduna.gee.publication.net.FileNames

ASA_FILE_NAME, BAK_FILE_NAME, CAT_FILE_NAME, CFG_FILE_NAME, CHS_FILE_NAME, DAT_FILE_NAME, HLP_FILE_NAME, LOCAL_FILE_PREFIX, SBS_FILE_NAME, SSS_FILE_NAME, WIF_FILE_NAME

Fields inherited from interface info.aduna.gee.publication.UserTypes

API_BIT, COVER_BUILDER_BIT, ENGINE_BIT, GUEST_BITS, OWNER_BITS, PRO_BITS, PROUSER_BIT, SERVER_BIT, SHOP_BIT, SHOW_BIT, SHOW_BITS, VISITOR_BIT

Constructor Summary

NavigationChannel(String server, String name)

NavigationChannel(String server, String name, String loginName, String password)

Method Summary

void	setNavigation(EntityContext context, NavigationSpecification navSpec, JitSectionRenderer renderer) Get the channelName from the EntityContext and use the system default Jazzz definitions.
void	setNavigation(EntityContext context, NavigationSpecification navSpec, JitSectionRenderer renderer, String pathToJazzzDefinition) Get the channelName from the EntityContext.
void	setNavigation(String channelName, NavigationSpecification navSpec, JitSectionRenderer renderer) Use the system default Jazzz definitions.
void	setNavigation(String channelName, NavigationSpecification navSpec, JitSectionRenderer renderer, String pathToJazzzDefinition) Let the NavigatonChannel navigate over all entities in the channel named channelName, according to the navigation specification in "navSpec" and each resulting section should be rendered by "renderer".

Methods inherited from class info.aduna.gee.spectacle.webserver.Channel

add, addSection, addSection, addSubscription, changeCover, changeSectionDesign, changeSectionDesign, clear, clearSubscriptions, close, finalize, getDatabase, getEntries, getLabelDefinitions, getLoginName, getName, getPassword, getSectionDesigns, getServer, inheritLabels, inheritPrivacyGroups, isLoggedIn, login, login, logout, preload, removeSection, removeSection, setCategories, setDatabase, setLabelColors, setLabelImages, setLabels, setPrivacy, setPrivacyGroups, setSectionLabels, setSectionPrivacy, setStartSection, setStorable, setStoreVersion, setTemplatePreference, sort, sort, sync, syncAll, uploadFile, uploadImage

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationChannel

public NavigationChannel(String server,
                         String name)
                  throws ChannelException

Throws:

ChannelException

NavigationChannel

public NavigationChannel(String server,
                         String name,
                         String loginName,
                         String password)
                  throws ChannelException

Throws:

ChannelException

Method Detail

setNavigation

public void setNavigation(EntityContext context,
                          NavigationSpecification navSpec,
                          JitSectionRenderer renderer)
                   throws ChannelException

Get the channelName from the EntityContext and use the system default Jazzz definitions.

Throws:

ChannelException

See Also:

setNavigation(String, NavigationSpecification, JitSectionRenderer, String)

setNavigation

public void setNavigation(EntityContext context,
                          NavigationSpecification navSpec,
                          JitSectionRenderer renderer,
                          String pathToJazzzDefinition)
                   throws ChannelException

Get the channelName from the EntityContext.

Throws:

ChannelException

See Also:

setNavigation(String, NavigationSpecification, JitSectionRenderer, String)

setNavigation

public void setNavigation(String channelName,
                          NavigationSpecification navSpec,
                          JitSectionRenderer renderer)
                   throws ChannelException

Use the system default Jazzz definitions.

Throws:

ChannelException

See Also:

setNavigation(String, NavigationSpecification, JitSectionRenderer, String)

setNavigation

public void setNavigation(String channelName,
                          NavigationSpecification navSpec,
                          JitSectionRenderer renderer,
                          String pathToJazzzDefinition)
                   throws ChannelException

Let the NavigatonChannel navigate over all entities in the channel named channelName, according to the navigation specification in "navSpec" and each resulting section should be rendered by "renderer".

Parameters:

channelName - the name of the channel containing the objects through which the navigation occurs

navSpec - the navigation specification

renderer - the section renderer

pathToJazzzDefinition - either null or an alternative path to all Jazzz definitions A non-null pathToJazzzDefinition is required only when your JitSectionRenderer is not part of the release. In that case, you should add Jazzz definitions for your tailor-made JitSectionRenderer to the total set of Jazzz definitions. The resulting file should be in you class path, and the path to this file (e.g. "com.mycompany.myproject.JazzzzDefinitions.xml") should be passed. In short: avoid tailor-made JitSectionRenderers as much as possible.

Throws:

ChannelException