org.sonar.squid

Class Squid

java.lang.Object

org.sonar.squid.Squid

All Implemented Interfaces:

DirectedGraphAccessor<SourceCode,SourceCodeEdge>, SourceCodeSearchEngine

public class Squid
extends Object
implements DirectedGraphAccessor<SourceCode,SourceCodeEdge>, SourceCodeSearchEngine

Constructor Summary

Constructors

Constructor and Description
Squid()
Squid(SquidConfiguration conf)

Method Summary

Methods

Modifier and Type	Method and Description
SourceProject	aggregate() Deprecated. use decorateSourceCodeTreeWith(MetricDef...) instead
SourceProject	decorateSourceCodeTreeWith(MetricDef... metrics)
void	flush()
SourceCodeEdge	getEdge(SourceCode from, SourceCode to)
List<SourceCodeEdge>	getEdges(Collection<SourceCode> vertices)
Collection<SourceCodeEdge>	getIncomingEdges(SourceCode to)
Collection<SourceCodeEdge>	getOutgoingEdges(SourceCode from)
SourceProject	getProject()
Set<SourceCode>	getVertices()
boolean	hasEdge(SourceCode from, SourceCode to)
<SCANNER extends CodeScanner> SCANNER	register(Class<SCANNER> scannerClass)
void	registerVisitor(Class<? extends CodeVisitor> visitor)
void	registerVisitor(CodeVisitor visitor)
Collection<SourceCode>	search(Query... query)
SourceCode	search(String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

Squid

public Squid(SquidConfiguration conf)

Squid

public Squid()

Method Detail

registerVisitor

public void registerVisitor(CodeVisitor visitor)

registerVisitor

public void registerVisitor(Class<? extends CodeVisitor> visitor)

register

public <SCANNER extends CodeScanner> SCANNER register(Class<SCANNER> scannerClass)

aggregate

@Deprecated
public SourceProject aggregate()

Deprecated. use decorateSourceCodeTreeWith(MetricDef...) instead

decorateSourceCodeTreeWith

public SourceProject decorateSourceCodeTreeWith(MetricDef... metrics)

getProject

public SourceProject getProject()

search

public SourceCode search(String key)

Specified by:

search in interface SourceCodeSearchEngine

search

public Collection<SourceCode> search(Query... query)

Specified by:

search in interface SourceCodeSearchEngine

getEdge

public SourceCodeEdge getEdge(SourceCode from,
                     SourceCode to)

Specified by:

getEdge in interface DirectedGraphAccessor<SourceCode,SourceCodeEdge>

getIncomingEdges

public Collection<SourceCodeEdge> getIncomingEdges(SourceCode to)

Specified by:

getIncomingEdges in interface DirectedGraphAccessor<SourceCode,SourceCodeEdge>

getOutgoingEdges

public Collection<SourceCodeEdge> getOutgoingEdges(SourceCode from)

Specified by:

getOutgoingEdges in interface DirectedGraphAccessor<SourceCode,SourceCodeEdge>

getVertices

public Set<SourceCode> getVertices()

Specified by:

getVertices in interface DirectedGraphAccessor<SourceCode,SourceCodeEdge>

getEdges

public List<SourceCodeEdge> getEdges(Collection<SourceCode> vertices)

hasEdge

public boolean hasEdge(SourceCode from,
              SourceCode to)

Specified by:

hasEdge in interface DirectedGraphAccessor<SourceCode,SourceCodeEdge>

flush

public void flush()