001/*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2012 SonarSource
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 */
020package org.sonar.batch.index;
021
022import org.sonar.api.database.model.Snapshot;
023import org.sonar.api.resources.Project;
024import org.sonar.api.resources.Resource;
025
026public interface ResourcePersister {
027  
028  Snapshot saveProject(Project project, Project parent);
029
030  /**
031   * Persist a resource in database. Returns null if the resource must not be persisted (scope lower than file)
032   */
033  Snapshot saveResource(Project project, Resource resource, Resource parent);
034
035  /**
036   * Persist a resource in database. Returns null if the resource must not be persisted (scope lower than file)
037   */
038  Snapshot saveResource(Project project, Resource resource);
039
040  Snapshot getSnapshot(Resource resource);
041
042  /**
043   * @throws ResourceNotPersistedException if the resource is not persisted.
044   */
045  Snapshot getSnapshotOrFail(Resource resource);
046 
047
048  /**
049   * The current snapshot which is flagged as "last", different then the current analysis.
050   * @param onlyOlder true if the result must be anterior to the snapshot parameter
051   */
052  Snapshot getLastSnapshot(Snapshot snapshot, boolean onlyOlder);
053
054  void clear();
055}