org.sonar.api.batch
Interface SensorContext


public interface SensorContext

Since:
1.10

Method Summary
 Event createEvent(Resource resource, String name, String description, String category, Date date)
          Creates an event for a given date
 void deleteEvent(Event event)
          Deletes an event
 void deleteLink(String key)
          remove a link.
 List<Event> getEvents(Resource resource)
           
 Measure getMeasure(Metric metric)
          Find a project measure
 Measure getMeasure(Resource resource, Metric metric)
          Find a measure for this project
<M> M
getMeasures(MeasuresFilter<M> filter)
          All measures of the project.
<M> M
getMeasures(Resource resource, MeasuresFilter<M> filter)
          Find all measures for this project.
 Resource getResource(String key)
           
 void saveLink(ProjectLink link)
          add a link to an external page like project homepage, sources (subversion, ...), continuous integration server...
 Measure saveMeasure(Measure measure)
          Add a measure on project
 Measure saveMeasure(Metric metric, Double value)
          Add a measure on project
 Measure saveMeasure(Resource resource, Measure measure)
          Add or update a measure.
 Measure saveMeasure(Resource resource, Metric metric, Double value)
          Add or update a measure.
 String saveResource(Resource resource)
          Key is updated when saving the resource.
 void saveSource(Resource resource, String source)
          Does nothing if the resource is set as excluded.
 void saveViolation(Violation violation)
          Saves a violation on a resource of the context
 void saveViolations(Collection<Violation> violations)
          Saves a list of violations
 

Method Detail

getMeasure

Measure getMeasure(Metric metric)
Find a project measure


getMeasures

<M> M getMeasures(MeasuresFilter<M> filter)
All measures of the project. Never return null.


saveMeasure

Measure saveMeasure(Measure measure)
Add a measure on project


saveMeasure

Measure saveMeasure(Metric metric,
                    Double value)
Add a measure on project


getMeasure

Measure getMeasure(Resource resource,
                   Metric metric)
Find a measure for this project


saveResource

String saveResource(Resource resource)
Key is updated when saving the resource.

Returns:
the key as saved in database. Null if the resource is set as excluded.

getResource

Resource getResource(String key)
Returns:
the resource associated to the key

getMeasures

<M> M getMeasures(Resource resource,
                  MeasuresFilter<M> filter)
Find all measures for this project. Never return null.


saveMeasure

Measure saveMeasure(Resource resource,
                    Metric metric,
                    Double value)
Add or update a measure.

The resource is automatically saved, so there is no need to execute the method saveResource(). Does nothing if the resource is set as excluded.


saveMeasure

Measure saveMeasure(Resource resource,
                    Measure measure)
Add or update a measure.

The resource is automatically saved, so there is no need to execute the method saveResource(). Does nothing if the resource is set as excluded.


saveViolation

void saveViolation(Violation violation)
Saves a violation on a resource of the context


saveViolations

void saveViolations(Collection<Violation> violations)
Saves a list of violations


saveSource

void saveSource(Resource resource,
                String source)
Does nothing if the resource is set as excluded.


saveLink

void saveLink(ProjectLink link)
add a link to an external page like project homepage, sources (subversion, ...), continuous integration server... Example : context.addLink(new ProjectLink("maven_site, "Maven site", "http://my.maven.com)


deleteLink

void deleteLink(String key)
remove a link. It does not fail if key is unknown.


getEvents

List<Event> getEvents(Resource resource)
Parameters:
resource - set null for project events

createEvent

Event createEvent(Resource resource,
                  String name,
                  String description,
                  String category,
                  Date date)
Creates an event for a given date

Parameters:
name - the event name
description - the event description
category - the event category
date - the event date
Returns:
the created event

deleteEvent

void deleteEvent(Event event)
Deletes an event

Parameters:
event - the event to delete


Copyright © 2009 SonarSource SA. All Rights Reserved.