BindingSource


1   // Copyright 2004, 2005 The Apache Software Foundation
2   //
3   // Licensed under the Apache License, Version 2.0 (the "License");
4   // you may not use this file except in compliance with the License.
5   // You may obtain a copy of the License at
6   //
7   //     http://www.apache.org/licenses/LICENSE-2.0
8   //
9   // Unless required by applicable law or agreed to in writing, software
10  // distributed under the License is distributed on an "AS IS" BASIS,
11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  // See the License for the specific language governing permissions and
13  // limitations under the License.
14  
15  package org.apache.tapestry.binding;
16  
17  import org.apache.hivemind.Location;
18  import org.apache.tapestry.IBinding;
19  import org.apache.tapestry.IComponent;
20  
21  /**
22   * Used to convert a binding string (from a template or a specification) into an instance of
23   * {@link IBinding}.
24   * 
25   * @since 4.0
26   */
27  public interface BindingSource
28  {
29      /**
30       * Creates a new binding. The locator is used to identify the <em>type</em> of binding to
31       * create as well as configure the binding instance. The locator is either a literal value
32       * (resulting in a {@link org.apache.tapestry.binding.LiteralBinding literal binding}) or
33       * consists of prefix and a path, i.e., <code>ognl:myProperty</code>.
34       * <p>
35       * When a prefix exists and is identified, it is used to select the correct
36       * {@link BindingFactory}, and the remainder of the path (i.e., <code>myProperty</code)
37       * is passed to the factory.  An unrecognized prefix is treated as a literal value
38       * (it is often "javascript:" or "http:", etc.).
39       * 
40       * @param component the component for which the binding is created; the component is used
41       * as a kind of context for certain types of bindings (for example, the root object when
42       * evaluating OGNL expressions).
43       * @param description {@link IBinding#getDescription() description} for the new binding
44       * @param reference the binding reference used to create the binding, possibly including a prefix to define the type.
45       * If the reference does not include a prefix, then  the defaultBindingType is used as the prefix
46       * @param defaultbindingType binding type to use when no prefix is provided in the reference
47       * or doesn't match a known binding factory.
48       * @param location location used to report errors in the binding
49       */
50      public IBinding createBinding(IComponent component, String   description, String   reference,
51              String   defaultBindingType, Location location);
52  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags