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 package org.apache.commons.betwixt.strategy;
20
21 import org.apache.commons.betwixt.io.read.MappingAction;
22 import org.apache.commons.betwixt.io.read.ReadContext;
23 import org.xml.sax.Attributes;
24
25 /**
26 * <p>
27 * Pluggable strategy interface used for free mappings.
28 * </p>
29 * <p>
30 * Free mappings (ones where the current mapping )
31 * are executed by calling a <code>ActionMappingStrategy</code>
32 * implementation.
33 * So, using a custom strategy is an easy way to
34 * customize the mapping.
35 * </p>
36 * @author <a href='http://commons.apache.org/'>Apache Commons Team</a>
37 * @version $Revision: 561314 $
38 */
39 public abstract class ActionMappingStrategy {
40
41 /**
42 * Default <code>ActionMappingStrategy</code>
43 * used by betwixt
44 */
45 public static final ActionMappingStrategy DEFAULT
46 = new DefaultActionMappingStrategy();
47
48 /**
49 * Gets the mapping action to map the given element.
50 * @param namespace not null
51 * @param name not null
52 * @param attributes <code>Attributes</code>, not null
53 * @param context <code>ReadContext</code>, not null
54 * @return <code>MappingAction</code>, not null
55 * @throws Exception
56 */
57 public abstract MappingAction getMappingAction(
58 String namespace,
59 String name,
60 Attributes attributes,
61 ReadContext context)
62 throws Exception;
63 }