001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.model.language;
018
019import java.util.Map;
020
021import javax.xml.bind.annotation.XmlAccessType;
022import javax.xml.bind.annotation.XmlAccessorType;
023import javax.xml.bind.annotation.XmlTransient;
024
025import org.apache.camel.CamelContext;
026import org.apache.camel.Expression;
027import org.apache.camel.Predicate;
028import org.apache.camel.spi.NamespaceAware;
029
030/**
031 * A useful base class for any expression which may be namespace or XML content
032 * aware such as {@link XPathExpression} or {@link XQueryExpression}
033 */
034@XmlAccessorType(XmlAccessType.FIELD)
035public abstract class NamespaceAwareExpression extends ExpressionDefinition implements NamespaceAware {
036    @XmlTransient
037    private Map<String, String> namespaces;
038
039    public NamespaceAwareExpression() {
040    }
041
042    public NamespaceAwareExpression(String expression) {
043        super(expression);
044    }
045
046    @Override
047    public Map<String, String> getNamespaces() {
048        return namespaces;
049    }
050
051    /**
052     * Injects the XML Namespaces of prefix -> uri mappings
053     *
054     * @param namespaces the XML namespaces with the key of prefixes and the
055     *            value the URIs
056     */
057    @Override
058    public void setNamespaces(Map<String, String> namespaces) {
059        this.namespaces = namespaces;
060    }
061
062    @Override
063    protected void configureExpression(CamelContext camelContext, Expression expression) {
064        configureNamespaceAware(expression);
065        super.configureExpression(camelContext, expression);
066    }
067
068    @Override
069    protected void configurePredicate(CamelContext camelContext, Predicate predicate) {
070        configureNamespaceAware(predicate);
071        super.configurePredicate(camelContext, predicate);
072    }
073
074    protected void configureNamespaceAware(Object builder) {
075        if (namespaces != null && builder instanceof NamespaceAware) {
076            NamespaceAware namespaceAware = (NamespaceAware)builder;
077            namespaceAware.setNamespaces(namespaces);
078        }
079    }
080}