edu.hm.hafner.analysis.parser

Class SonarQubeParser

java.lang.Object

edu.hm.hafner.analysis.IssueParser

edu.hm.hafner.analysis.AbstractParser

edu.hm.hafner.analysis.parser.SonarQubeParser

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SonarQubeDiffParser, SonarQubeIssuesParser

public abstract class SonarQubeParser
extends AbstractParser

Base class for SonarQube parsers.

Author:

Carles Capdevila

See Also:

Serialized Form

Field Summary

Fields inherited from class edu.hm.hafner.analysis.AbstractParser

DEPRECATION, PROPRIETARY_API

Constructor Summary

Constructors

Constructor and Description
SonarQubeParser()

Method Summary

Modifier and Type	Method and Description
boolean	filterIssue(org.json.JSONObject issue) Decides whether or not to parse and add an issue.
protected abstract String	getModulePath(org.json.JSONObject component, org.json.JSONObject issue) Extracts the module path from the specified JSON objects.
Report	parse(Reader reader, Function<String,String> preProcessor) Parses the specified input stream for issues.
protected String	parseModulePath(org.json.JSONObject moduleKeyObject, String componentKey) Find the module path inside the corresponding component.

Methods inherited from class edu.hm.hafner.analysis.AbstractParser

getFileName, guessCategory, guessCategoryIfEmpty, parse, parse, parseInt

Methods inherited from class edu.hm.hafner.analysis.IssueParser

parse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SonarQubeParser

public SonarQubeParser()

Method Detail

parse

public Report parse(Reader reader,
                    Function<String,String> preProcessor)
             throws ParsingCanceledException,
                    ParsingException

Description copied from class: AbstractParser

Parses the specified input stream for issues.

Specified by:

parse in class AbstractParser

Parameters:

reader - the reader to get the text from

preProcessor - pre processes each input line before handing it to the actual parser

Returns:

the issues

Throws:

ParsingCanceledException - Signals that the parsing has been aborted by the user

ParsingException - Signals that during parsing a non recoverable error has been occurred

filterIssue

public boolean filterIssue(org.json.JSONObject issue)

Decides whether or not to parse and add an issue.

Parameters:

issue - the issue to filter.

Returns:

true if the issue is to be parsed and added, otherwise false

getModulePath

protected abstract String getModulePath(org.json.JSONObject component,
                                        org.json.JSONObject issue)

Extracts the module path from the specified JSON objects.

Parameters:

component - the component

issue - the issue

Returns:

the module path

parseModulePath

protected String parseModulePath(org.json.JSONObject moduleKeyObject,
                                 String componentKey)

Find the module path inside the corresponding component.

Parameters:

moduleKeyObject - the object which contains the component key.

componentKey - the component key.

Returns:

the module path.