package org.apache.turbine.modules.navigations;

 /*

  * Licensed to the Apache Software Foundation (ASF) under one

  * or more contributor license agreements.  See the NOTICE file

  * distributed with this work for additional information

  * regarding copyright ownership.  The ASF licenses this file

  * to you under the Apache License, Version 2.0 (the

  * "License"); you may not use this file except in compliance

  * with the License.  You may obtain a copy of the License at

  *

  *   http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing,

  * software distributed under the License is distributed on an

  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

  * KIND, either express or implied.  See the License for the

  * specific language governing permissions and limitations

  * under the License.

  */

 import org.apache.turbine.annotation.TurbineService;

 import org.apache.turbine.modules.Navigation;

 import org.apache.turbine.pipeline.PipelineData;

 import org.apache.turbine.services.template.TemplateService;

 import org.apache.turbine.services.velocity.VelocityService;

 import org.apache.turbine.util.RunData;

 import org.apache.velocity.context.Context;

 /**

  * VelocityNavigation.  This screen relies on the VelocityPage

  * being set as the default page.  The doBuildTemplate() assumes the

  * user has put the template filename in the RunData parameter and set

  * it to the value of the template file to execute.  Specialized

  * Navigations screens should extend this class and override the

  * doBuildTemplate( data , context) method.

  *

  * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>

  * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>

  * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>

  * @version $Id: VelocityNavigation.java 1773378 2016-12-09 13:19:59Z tv $

  */

 public class VelocityNavigation

         extends TemplateNavigation

 {

     /** The prefix for lookup up navigation pages */

     private final String prefix = Navigation.PREFIX + "/";

     /** Injected service instance */

     @TurbineService

     private VelocityService velocity;

     /** Injected service instance */

     @TurbineService

     private TemplateService templateService;

     /**

      * Velocity Navigations extending this class should override this

      * method to perform any particular business logic and add

      * information to the context.

      *

      * @param pipelineData Turbine information.

      * @param context Context for web pages.

      * @throws Exception a generic exception.

      */

     protected void doBuildTemplate(PipelineData pipelineData,

                                    Context context)

             throws Exception

     {

         // empty

     }

     /**

      * Needs to be implemented to make TemplateNavigation like us.

      * The actual method that you should override is the one with the

      * context in the parameter list.

      *

      * @param pipelineData Turbine information.

      * @throws Exception a generic exception.

      */

     @Override

     protected void doBuildTemplate(PipelineData pipelineData)

             throws Exception

     {

         doBuildTemplate(pipelineData, velocity.getContext(pipelineData));

     }

     /**

      * This builds the Velocity template.

      *

      * @param pipelineData Turbine information.

      * @return the content of the navigation module

      * @throws Exception a generic exception.

      */

     @Override

     public String buildTemplate(PipelineData pipelineData)

             throws Exception

     {

         RunData data = getRunData(pipelineData);

         Context context = velocity.getContext(pipelineData);

         String navigationTemplate = data.getTemplateInfo().getNavigationTemplate();

         String templateName

                 = templateService.getNavigationTemplateName(navigationTemplate);

         return velocity.handleRequest(context, prefix + templateName);

     }

 }