001    /**
002     * Copyright (c) 2010, SIB. All rights reserved.
003     * 
004     * SIB (Swiss Institute of Bioinformatics) - http://www.isb-sib.ch Host -
005     * https://sourceforge.net/projects/javaprotlib/
006     * 
007     * Redistribution and use in source and binary forms, with or without
008     * modification, are permitted provided that the following conditions are met:
009     * Redistributions of source code must retain the above copyright notice, this
010     * list of conditions and the following disclaimer. Redistributions in binary
011     * form must reproduce the above copyright notice, this list of conditions and
012     * the following disclaimer in the documentation and/or other materials provided
013     * with the distribution. Neither the name of the SIB/GENEBIO nor the names of
014     * its contributors may be used to endorse or promote products derived from this
015     * software without specific prior written permission.
016     * 
017     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
018     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
019     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
020     * ARE DISCLAIMED. IN NO EVENT SHALL SIB/GENEBIO BE LIABLE FOR ANY DIRECT,
021     * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
022     * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
023     * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
024     * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
026     * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027     */
028    package org.expasy.jpl.commons.base.cond;
029    
030    
031    import java.util.Set;
032    import org.apache.commons.collections15.Predicate;
033    import org.expasy.jpl.commons.base.TypedDataContainer;
034    import org.expasy.jpl.commons.base.cond.operator.api.Operator;
035    
036    
037    /**
038     * The {@code Condition} interface should be implemented by any condition that
039     * have to be tested on any T-object.
040     * 
041     * @author nikitin
042     * 
043     * @param T the object type.
044     * 
045     * @version 1.0
046     * 
047     */
048    public interface Condition<T> extends Predicate<T> {
049            
050            /** @return true if the input (many possible variables) satisfy the condition */
051            boolean evaluate(TypedDataContainer input);
052            
053            /** @return the set of condition-dependent variable names */
054            Set<String> getDependentVariables();
055            
056            /** @return operator */
057            Operator<?, ?> getOperator();
058            
059            /** @return true if the condition is applying the not operator */
060            boolean isNotCondition();
061            
062            /** simply print the commands */
063            void printStackCommands();
064            
065            /** the name (have to respect the file name convention) */
066            String getName();
067    }