001 /* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2014 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * SonarQube 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 * SonarQube 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 License 017 * along with this program; if not, write to the Free Software Foundation, 018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 019 */ 020 package org.sonar.api.batch; 021 022 import org.sonar.api.design.Dependency; 023 import org.sonar.api.measures.Measure; 024 import org.sonar.api.measures.MeasuresFilter; 025 import org.sonar.api.resources.Project; 026 import org.sonar.api.resources.ProjectLink; 027 import org.sonar.api.resources.Resource; 028 import org.sonar.api.rules.Violation; 029 import org.sonar.api.violations.ViolationQuery; 030 import org.sonar.graph.DirectedGraphAccessor; 031 032 import javax.annotation.CheckForNull; 033 034 import java.util.Collection; 035 import java.util.Date; 036 import java.util.List; 037 import java.util.Set; 038 039 public abstract class SonarIndex implements DirectedGraphAccessor<Resource, Dependency> { 040 041 /** 042 * Indexes a resource as a direct child of project. This method does nothing and returns true if the resource already indexed. 043 * If the method resource.getParent() does not return null, then this parent will be indexed too. 044 * 045 * @return false if the resource is excluded 046 * @since 2.6 047 */ 048 public abstract boolean index(Resource resource); 049 050 /** 051 * Indexes a resource. This method does nothing if the resource is already indexed. 052 * 053 * @param resource the resource to index. Not nullable 054 * @param parentReference a reference to the indexed parent. If null, the resource is indexed as a direct child of project. 055 * @return false if the parent is not indexed or if the resource is excluded 056 * @since 2.6 057 */ 058 public abstract boolean index(Resource resource, Resource parentReference); 059 060 /** 061 * Returns true if the referenced resource is excluded. An excluded resource is not indexed. 062 * @since 2.6 063 */ 064 public abstract boolean isExcluded(Resource reference); 065 066 /** 067 * @since 2.6 068 */ 069 public abstract boolean isIndexed(Resource reference, boolean acceptExcluded); 070 071 /** 072 * Search for an indexed resource. 073 * 074 * @param reference the resource reference 075 * @return the indexed resource, null if it's not indexed 076 * @since 1.10. Generic types since 2.6. 077 */ 078 public abstract <R extends Resource> R getResource(R reference); 079 080 /** 081 * @since 2.6 082 */ 083 public abstract Resource getParent(Resource reference); 084 085 /** 086 * @since 2.6 087 */ 088 089 public abstract Collection<Resource> getChildren(Resource reference); 090 091 /** 092 * Save the source code of a file. The file must be have been indexed before. 093 * Note: the source stream is not closed. 094 * 095 * @throws org.sonar.api.resources.DuplicatedSourceException 096 * if the source has already been set on this resource 097 * @deprecated since 4.2 should not be used by plugins 098 */ 099 @Deprecated 100 public abstract void setSource(Resource reference, String source); 101 102 /** 103 * @return source code associated with a specified resource, <code>null</code> if not available 104 * (for example when sonar.importSources=false) 105 * @since 2.9 106 */ 107 @CheckForNull 108 public abstract String getSource(Resource resource); 109 110 public abstract Project getProject(); 111 112 public final Collection<Resource> getResources() { 113 return getVertices(); 114 } 115 116 /** 117 * Indexes the resource. 118 * @return the indexed resource, even if it's excluded 119 * @deprecated since 2.6. Use methods index() 120 */ 121 @Deprecated 122 public abstract Resource addResource(Resource resource); 123 124 @CheckForNull 125 public abstract Measure getMeasure(Resource resource, org.sonar.api.batch.measure.Metric<?> metric); 126 127 @CheckForNull 128 public abstract <M> M getMeasures(Resource resource, MeasuresFilter<M> filter); 129 130 /** 131 * Returns the violations that match the {@link ViolationQuery} parameters. 132 * 133 * @since 2.8 134 * @param violationQuery 135 * the request parameters specified as a {@link ViolationQuery} 136 * @return the list of violations that match those parameters 137 * @deprecated in 3.6 138 */ 139 @Deprecated 140 public abstract List<Violation> getViolations(ViolationQuery violationQuery); 141 142 /** 143 * Returns all the active (= non switched-off) violations found on the given resource. Equivalent to 144 * {@link #getViolations(ViolationQuery)} called with <code>ViolationQuery.create().forResource(resource).ignoreSwitchedOff(true)</code> 145 * as a parameter. 146 * 147 * @since 2.7 148 * @return the list of violations 149 * @deprecated in 3.6 150 */ 151 @Deprecated 152 public final List<Violation> getViolations(Resource resource) { 153 return getViolations(ViolationQuery.create().forResource(resource)); 154 } 155 156 /** 157 * @since 2.5 158 * @deprecated in 3.6 159 */ 160 @Deprecated 161 public abstract void addViolation(Violation violation, boolean force); 162 163 /** 164 * @deprecated in 3.6 165 */ 166 @Deprecated 167 public final void addViolation(Violation violation) { 168 addViolation(violation, false); 169 } 170 171 /** 172 * Warning: the resource is automatically indexed for backward-compatibility, but it should be explictly 173 * indexed before. Next versions will deactivate this automatic indexation. 174 */ 175 public abstract Measure addMeasure(Resource resource, Measure measure); 176 177 public abstract Dependency addDependency(Dependency dependency); 178 179 public abstract Set<Dependency> getDependencies(); 180 181 public abstract void addLink(ProjectLink link); 182 183 public abstract void deleteLink(String key); 184 185 public abstract List<Event> getEvents(Resource resource); 186 187 public abstract void deleteEvent(Event event); 188 189 public abstract Event addEvent(Resource resource, String name, String description, String category, Date date); 190 191 public final Collection<Dependency> getOutgoingDependencies(Resource from) { 192 return getOutgoingEdges(from); 193 } 194 195 public final Collection<Dependency> getIncomingDependencies(Resource to) { 196 return getIncomingEdges(to); 197 } 198 }