001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * Sonar is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.batch;
021    
022    import java.util.Collection;
023    
024    import org.sonar.api.BatchExtension;
025    import org.sonar.squid.api.Query;
026    import org.sonar.squid.api.SourceCode;
027    
028    /**
029     * The extension point to access the Squid data tree
030     *
031     * @since 1.11
032     */
033    public interface SquidSearch extends BatchExtension {
034      /**
035       * Returns a list of SourceCode objects base a set of queries given
036       *
037       * @param query the set of query
038       * @return SourceCode objects
039       */
040      Collection<SourceCode> search(Query... query);
041    
042      /**
043       * Returns a SourceObject given its key
044       *
045       * @param key the key
046       * @return SourceCode object
047       */
048      SourceCode search(String key);
049    }