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;
018
019import javax.xml.bind.annotation.XmlAccessType;
020import javax.xml.bind.annotation.XmlAccessorType;
021import javax.xml.bind.annotation.XmlRootElement;
022
023import org.apache.camel.Predicate;
024import org.apache.camel.model.language.ExpressionDefinition;
025import org.apache.camel.spi.AsPredicate;
026import org.apache.camel.spi.Metadata;
027
028/**
029 * Filter out messages based using a predicate
030 */
031@Metadata(label = "eip,routing")
032@AsPredicate
033@XmlRootElement(name = "filter")
034@XmlAccessorType(XmlAccessType.FIELD)
035public class FilterDefinition extends OutputExpressionNode {
036
037    public FilterDefinition() {
038    }
039
040    public FilterDefinition(ExpressionDefinition expression) {
041        super(expression);
042    }
043
044    public FilterDefinition(Predicate predicate) {
045        super(predicate);
046    }
047
048    @Override
049    public String toString() {
050        return "Filter[" + getExpression() + " -> " + getOutputs() + "]";
051    }
052
053    @Override
054    public String getShortName() {
055        return "filter";
056    }
057
058    @Override
059    public String getLabel() {
060        return "filter[" + getExpression() + "]";
061    }
062
063    /**
064     * Expression to determine if the message should be filtered or not. If the
065     * expression returns an empty value or <tt>false</tt> then the message is
066     * filtered (dropped), otherwise the message is continued being routed.
067     */
068    @Override
069    public void setExpression(ExpressionDefinition expression) {
070        // override to include javadoc what the expression is used for
071        super.setExpression(expression);
072    }
073}