enhancer/benchmark/src/main/java/org/apache/stanbol/enhancer/benchmark/TripleMatcherGroup.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to You under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.apache.stanbol.enhancer.benchmark;

import java.util.Collection;
import java.util.Set;

import org.apache.clerezza.commons.rdf.ImmutableGraph;
import org.apache.clerezza.commons.rdf.IRI;

/** A group of TripleMatcher, used to check that 
 *  enhancements match all the TripleMatcher in 
 *  the group. 
 */
public interface TripleMatcherGroup {
    /** @return this group's description */
    String getDescription();
    
    /** An "expect" group is expected to be found in
     *  the input, whereas non-expect ("complain") groups
     *  should not be found 
     */
    boolean isExpectGroup();
    
    /** Return the set of IRI that match all
     *  TripleMatcher in this group for supplied ImmutableGraph
     */
    Set<IRI> getMatchingSubjects(ImmutableGraph g);
    
    /** @return our TripleMatcher */
    Collection<TripleMatcher> getMatchers();
}