2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  /*
19   * $Id: FormBuilderRule.java 464373 2006-10-16 04:21:54Z rahul $
20   */
21  package org.apache.shale.clay.parser.builder.chain;
22  
23  import org.apache.commons.chain.Command;
24  import org.apache.commons.chain.Context;
25  import org.apache.shale.clay.parser.Node;
26  import org.apache.shale.clay.parser.builder.Builder;
27  import org.apache.shale.clay.parser.builder.FormBuilder;
28  
29  /***
30   * <p>
31   * This rule has an implied mapping meaning that all html form nodes will map to
32   * the {@link FormBuilder} regardless if the html form attribute has a
33   * <code>jsfid</code>.
34   * </p>
35   */
36  public class FormBuilderRule implements Command {
37  
38      /***
39       * <p>
40       * Instance of the {@link FormBuilder}.
41       * </p>
42       */
43      private static final Builder BUILDER = new FormBuilder();
44  
45      /***
46       * <p>
47       * Uses the {@link BuilderRuleContext} to find the current html {@link Node}.
48       * If the node is a form, return an instance if the builder and stop the
49       * chain.
50       * </p>
51       *
52       * @param context commons chains
53       * @return <code>true</code> if the command ends the chain
54       * @exception Exception pushes an exception back to the invoking Command
55       */
56      public boolean execute(Context context) throws Exception {
57          boolean isFinal = false;
58  
59          BuilderRuleContext builderRuleContext = (BuilderRuleContext) context;
60          Node node = builderRuleContext.getNode();
61          if (!node.isComment() && node.getName() != null
62              && node.getName().equalsIgnoreCase("form")) {
63  
64              builderRuleContext.setBuilder(BUILDER);
65              isFinal = true;
66          }
67  
68          return isFinal;
69      }
70  
71  }