View Javadoc

1   /*
2    * Copyright 2005-2010 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.xml.xpath;
18  
19  import org.w3c.dom.DOMException;
20  import org.w3c.dom.Node;
21  
22  /**
23   * An interface used by [email protected] XPathOperations} implementations for mapping [email protected] Node} objects on a per-node basis.
24   * Implementations of this interface perform the actual work of mapping each node to a result object, but don't need to
25   * worry about exception handling.
26   *
27   * @author Arjen Poutsma
28   * @see XPathOperations#evaluate(String,javax.xml.transform.Source,NodeMapper)
29   * @see XPathOperations#evaluateAsObject(String,javax.xml.transform.Source,NodeMapper)
30   * @see XPathExpression#evaluate(org.w3c.dom.Node,NodeMapper)
31   * @see XPathExpression#evaluateAsObject(org.w3c.dom.Node,NodeMapper)
32   * @since 1.0.0
33   */
34  public interface NodeMapper<T> {
35  
36      /**
37       * Maps a single node to an arbitrary object.
38       *
39       * @param node    the node to map
40       * @param nodeNum the number of the current node
41       * @return object for the current node
42       * @throws DOMException in case of DOM errors
43       */
44      T mapNode(Node node, int nodeNum) throws DOMException;
45  
46  }