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 javax.xml.bind.annotation.XmlAccessType;
020import javax.xml.bind.annotation.XmlAccessorType;
021import javax.xml.bind.annotation.XmlAttribute;
022import javax.xml.bind.annotation.XmlRootElement;
023
024import org.apache.camel.spi.Metadata;
025
026/**
027 * Tokenize XML payloads using the specified path expression.
028 *
029 * @see org.apache.camel.language.xtokenizer.XMLTokenizeLanguage
030 */
031@Metadata(firstVersion = "2.14.0", label = "language,core,xml", title = "XML Tokenize")
032@XmlRootElement(name = "xtokenize")
033@XmlAccessorType(XmlAccessType.FIELD)
034public class XMLTokenizerExpression extends NamespaceAwareExpression {
035    @XmlAttribute
036    private String headerName;
037    @XmlAttribute
038    private String mode;
039    @XmlAttribute
040    @Metadata(javaType = "java.lang.Integer")
041    private String group;
042
043    public XMLTokenizerExpression() {
044    }
045
046    public XMLTokenizerExpression(String expression) {
047        super(expression);
048    }
049
050    @Override
051    public String getLanguage() {
052        return "xtokenize";
053    }
054
055    public String getHeaderName() {
056        return headerName;
057    }
058
059    /**
060     * Name of header to tokenize instead of using the message body.
061     */
062    public void setHeaderName(String headerName) {
063        this.headerName = headerName;
064    }
065
066    public String getMode() {
067        return mode;
068    }
069
070    /**
071     * The extraction mode. The available extraction modes are:
072     * <ul>
073     * <li>i - injecting the contextual namespace bindings into the extracted
074     * token (default)</li>
075     * <li>w - wrapping the extracted token in its ancestor context</li>
076     * <li>u - unwrapping the extracted token to its child content</li>
077     * <li>t - extracting the text content of the specified element</li>
078     * </ul>
079     */
080    public void setMode(String mode) {
081        this.mode = mode;
082    }
083
084    public String getGroup() {
085        return group;
086    }
087
088    /**
089     * To group N parts together
090     */
091    public void setGroup(String group) {
092        this.group = group;
093    }
094
095}