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 package org.apache.commons.jxpath.ri.model;
18
19 import java.util.Locale;
20
21 import org.apache.commons.jxpath.ri.QName;
22
23 /**
24 * Creates NodePointers for objects of a certain type.
25 * NodePointerFactories are ordered according to the values returned
26 * by the "getOrder" method and always queried in that order.
27 *
28 * @author Dmitri Plotnikov
29 * @version $Revision: 652845 $ $Date: 2008-05-02 19:46:46 +0200 (Fr, 02 Mai 2008) $
30 */
31 public interface NodePointerFactory {
32
33 /**
34 * The factory order number determines its position between other factories.
35 * @return int order
36 */
37 int getOrder();
38
39 /**
40 * Create a NodePointer for the supplied object. The node will represent
41 * the "root" object for a path.
42 *
43 * @param name String node name
44 * @param object child object
45 * @param locale Locale
46 * @return null if this factory does not recognize objects of the supplied
47 * type.
48 */
49 NodePointer createNodePointer(QName name, Object object, Locale locale);
50
51 /**
52 * Create a NodePointer for the supplied child object.
53 *
54 * @param parent parent node
55 * @param name String node name
56 * @param object child object
57 * @return null if this factory does not recognize objects of the supplied
58 * type.
59 */
60 NodePointer createNodePointer(
61 NodePointer parent,
62 QName name,
63 Object object);
64 }