org.outerj.daisy.navigation.impl
Class CommonNavigationManager

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.outerj.daisy.navigation.impl.CommonNavigationManager
All Implemented Interfaces:
org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable

public class CommonNavigationManager
extends org.apache.avalon.framework.logger.AbstractLogEnabled
implements org.apache.avalon.framework.service.Serviceable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.activity.Disposable

Component providing the functionality to generate navigation trees. This component does not provide any service of itself, but registers an extension with the repository.


Nested Class Summary
 class CommonNavigationManager.Context
           
 
Constructor Summary
CommonNavigationManager()
           
 
Method Summary
 void configure(org.apache.avalon.framework.configuration.Configuration configuration)
           
 void dispose()
           
 void generateNavigationTree(org.xml.sax.ContentHandler contentHandler, org.outerj.daisy.navigation.NavigationParams navigationParams, org.outerj.daisy.repository.VariantKey activeDocument, boolean handleErrors, long userId, long[] roleIds)
           
 void generatePreviewNavigationTree(org.xml.sax.ContentHandler contentHandler, java.lang.String navigationTreeXml, long branchId, long languageId, long userId, long[] roleIds)
           
 void initialize()
           
 org.outerj.daisy.navigation.NavigationLookupResult lookup(java.lang.String navigationPath, long requestedBranchId, long requestedLanguageId, org.outerj.daisy.navigation.LookupAlternative[] lookupAlternatives, long userId, long[] activeRoleIds)
           
 java.lang.String reverseLookup(org.outerj.daisy.repository.VariantKey document, org.outerj.daisy.repository.VariantKey navigationDoc, org.outerj.daisy.navigation.NavigationVersionMode versionMode)
           
 void service(org.apache.avalon.framework.service.ServiceManager serviceManager)
           
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommonNavigationManager

public CommonNavigationManager()
Method Detail

configure

public void configure(org.apache.avalon.framework.configuration.Configuration configuration)
               throws org.apache.avalon.framework.configuration.ConfigurationException
Specified by:
configure in interface org.apache.avalon.framework.configuration.Configurable
Throws:
org.apache.avalon.framework.configuration.ConfigurationException

service

public void service(org.apache.avalon.framework.service.ServiceManager serviceManager)
             throws org.apache.avalon.framework.service.ServiceException
Specified by:
service in interface org.apache.avalon.framework.service.Serviceable
Throws:
org.apache.avalon.framework.service.ServiceException

initialize

public void initialize()
                throws java.lang.Exception
Specified by:
initialize in interface org.apache.avalon.framework.activity.Initializable
Throws:
java.lang.Exception

generateNavigationTree

public void generateNavigationTree(org.xml.sax.ContentHandler contentHandler,
                                   org.outerj.daisy.navigation.NavigationParams navigationParams,
                                   org.outerj.daisy.repository.VariantKey activeDocument,
                                   boolean handleErrors,
                                   long userId,
                                   long[] roleIds)
                            throws org.outerj.daisy.navigation.NavigationException,
                                   org.xml.sax.SAXException
Throws:
org.outerj.daisy.navigation.NavigationException
org.xml.sax.SAXException

generatePreviewNavigationTree

public void generatePreviewNavigationTree(org.xml.sax.ContentHandler contentHandler,
                                          java.lang.String navigationTreeXml,
                                          long branchId,
                                          long languageId,
                                          long userId,
                                          long[] roleIds)
                                   throws org.outerj.daisy.navigation.NavigationException,
                                          org.xml.sax.SAXException
Throws:
org.outerj.daisy.navigation.NavigationException
org.xml.sax.SAXException

lookup

public org.outerj.daisy.navigation.NavigationLookupResult lookup(java.lang.String navigationPath,
                                                                 long requestedBranchId,
                                                                 long requestedLanguageId,
                                                                 org.outerj.daisy.navigation.LookupAlternative[] lookupAlternatives,
                                                                 long userId,
                                                                 long[] activeRoleIds)
                                                          throws org.outerj.daisy.navigation.NavigationException
Throws:
org.outerj.daisy.navigation.NavigationException

reverseLookup

public java.lang.String reverseLookup(org.outerj.daisy.repository.VariantKey document,
                                      org.outerj.daisy.repository.VariantKey navigationDoc,
                                      org.outerj.daisy.navigation.NavigationVersionMode versionMode)
                               throws org.outerj.daisy.repository.RepositoryException
Throws:
org.outerj.daisy.repository.RepositoryException

dispose

public void dispose()
Specified by:
dispose in interface org.apache.avalon.framework.activity.Disposable


Copyright © -2012 . All Rights Reserved.