org.sonar.plugins.api.maven
Class AbstractViolationsStaxParser

java.lang.Object
  org.sonar.plugins.api.maven.AbstractViolationsStaxParser

public abstract class AbstractViolationsStaxParser
extends java.lang.Object

Constructor Summary

protected

AbstractViolationsStaxParser(ProjectContext context, RulesManager rulesManager)

Method Summary

void	collect(java.io.File violationsXMLFile)
protected abstract org.codehaus.staxmate.in.SMInputCursor	cursorForResources(org.codehaus.staxmate.in.SMInputCursor rootCursor) Cursor for child resources to parse, the returned input cursor should be filtered on SMEvent.START_ELEMENT for optimal perfs
protected abstract org.codehaus.staxmate.in.SMInputCursor	cursorForViolations(org.codehaus.staxmate.in.SMInputCursor resourcesCursor) Cursor for violations to parse for a given resource, the returned input cursor should be filtered on SMEvent.START_ELEMENT for optimal perfs
protected abstract java.lang.String	keyForPlugin()
protected abstract RuleFailureLevel	levelForViolation(org.codehaus.staxmate.in.SMInputCursor violationCursor)
protected abstract java.lang.String	lineNumberForViolation(org.codehaus.staxmate.in.SMInputCursor violationCursor)
protected abstract java.lang.String	messageFor(org.codehaus.staxmate.in.SMInputCursor violationCursor)
protected abstract java.lang.String	ruleKey(org.codehaus.staxmate.in.SMInputCursor violationCursor)
protected abstract Resource	toResource(org.codehaus.staxmate.in.SMInputCursor resourceCursor) Transforms a given xml resource to a resource Object

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractViolationsStaxParser

protected AbstractViolationsStaxParser(ProjectContext context,
                                       RulesManager rulesManager)

Method Detail

cursorForResources

protected abstract org.codehaus.staxmate.in.SMInputCursor cursorForResources(org.codehaus.staxmate.in.SMInputCursor rootCursor)
                                                                      throws javax.xml.stream.XMLStreamException

Cursor for child resources to parse, the returned input cursor should be filtered on SMEvent.START_ELEMENT for optimal perfs

Parameters:

rootCursor - the root xml doc cursor

Returns:

a cursor with child resources elements to parse

Throws:

javax.xml.stream.XMLStreamException

cursorForViolations

protected abstract org.codehaus.staxmate.in.SMInputCursor cursorForViolations(org.codehaus.staxmate.in.SMInputCursor resourcesCursor)
                                                                       throws javax.xml.stream.XMLStreamException

Cursor for violations to parse for a given resource, the returned input cursor should be filtered on SMEvent.START_ELEMENT for optimal perfs

Parameters:

resourcesCursor - the current resource cursor

Returns:

a cursor with child violations elements to parse

Throws:

javax.xml.stream.XMLStreamException

toResource

protected abstract Resource toResource(org.codehaus.staxmate.in.SMInputCursor resourceCursor)
                                throws javax.xml.stream.XMLStreamException

Transforms a given xml resource to a resource Object

Parameters:

resourceCursor -

Returns:

Throws:

javax.xml.stream.XMLStreamException

messageFor

protected abstract java.lang.String messageFor(org.codehaus.staxmate.in.SMInputCursor violationCursor)
                                        throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

ruleKey

protected abstract java.lang.String ruleKey(org.codehaus.staxmate.in.SMInputCursor violationCursor)
                                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

keyForPlugin

protected abstract java.lang.String keyForPlugin()

levelForViolation

protected abstract RuleFailureLevel levelForViolation(org.codehaus.staxmate.in.SMInputCursor violationCursor)
                                               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

lineNumberForViolation

protected abstract java.lang.String lineNumberForViolation(org.codehaus.staxmate.in.SMInputCursor violationCursor)
                                                    throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

collect

public void collect(java.io.File violationsXMLFile)
             throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException