Package com.hello2morrow.sonargraph.core.api.model

Class ModuleAccess

java.lang.Object

com.hello2morrow.sonargraph.core.api.model.ElementAccess<com.hello2morrow.sonargraph.core.model.workspace.Module>

com.hello2morrow.sonargraph.core.api.model.ModuleAccess

All Implemented Interfaces:

IElementAccess, IModuleAccess, INamedElementAccess

Direct Known Subclasses:

CppModuleAccess, CSharpModuleAccess, JavaModuleAccess, PythonModuleAccess

public class ModuleAccess
extends ElementAccess<com.hello2morrow.sonargraph.core.model.workspace.Module>
implements IModuleAccess

Access class for parse model modules.

Nested Class Summary

Nested classes/interfaces inherited from class com.hello2morrow.sonargraph.core.api.model.ElementAccess

ElementAccess.IAccessFactory

Nested classes/interfaces inherited from interface com.hello2morrow.sonargraph.api.model.IModuleAccess

IModuleAccess.IVisitor

Nested classes/interfaces inherited from interface com.hello2morrow.sonargraph.api.model.INamedElementAccess

INamedElementAccess.INamedElementAccessVisitor

Constructor Summary

Constructors

Constructor	Description
ModuleAccess(com.hello2morrow.sonargraph.core.model.workspace.Module element)	Internal use only

Method Summary

Modifier and Type	Method	Description
void	accept(INamedElementAccess.INamedElementAccessVisitor visitor)	Internal
java.lang.Float	getACDMetric()
java.lang.Integer	getBiggestComponentCycleGroupMetric()
java.lang.Integer	getCCDMetric()
java.lang.Integer	getCodeCommentLinesMetric()
java.lang.Integer	getCommentLinesMetric()
java.lang.Integer	getComponentComponentDependenciesToCutMetric()
java.lang.Integer	getComponentCyclicityMetric()
java.lang.Integer	getComponentReferencesToCutMetric()
java.lang.Float	getComponentRelativeCyclicityMetric()
java.lang.Integer	getComponentStructuralDebtIndexMetric()
java.lang.String	getLanguage()	Get the language of this module.
java.lang.Integer	getLinesOfCodeMetric()
java.lang.Float	getMaintainabilityLevelMetric()
java.lang.Object	getMetricLevel()	Internal use only
java.lang.Float	getNCCDMetric()
java.lang.Integer	getNumberOfAllViolatingComponentsMetric()	Deprecated.
java.lang.Integer	getNumberOfComponentCycleGroupsMetric()
java.lang.Integer	getNumberOfComponentsMetric()
java.lang.Integer	getNumberOfComponentViolationsMetric()
java.lang.Integer	getNumberOfCyclicComponentsMetric()
java.lang.Integer	getNumberOfIgnoredCyclicComponentsMetric()
java.lang.Integer	getNumberOfIgnoredParserDependencyViolationsMetric()
java.lang.Integer	getNumberOfParserDependencyViolationsMetric()
java.lang.Integer	getNumberOfStatementsMetric()
java.lang.Integer	getNumberOfUnassignedComponentsMetric()
java.lang.Integer	getNumberOfViolatingComponentsMetric()
java.lang.Float	getPropagationCostMetric()
java.lang.Integer	getSourceElementCountMetric()
java.util.List<IDirectoryAccess>	getSourceRootDirectories()
java.lang.Integer	getTotalLinesMetric()

Methods inherited from class com.hello2morrow.sonargraph.core.api.model.ElementAccess

equals, getChildren, getElement, getFullyQualifiedName, getIncomingDependenciesRecursively, getIncomingDependenciesRecursively, getIssueCount, getName, getNameWithSignature, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getParent, getParent, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencingElementsRecursively, getReferencingElementsRecursively, getShortName, getShortNameWithSignature, hashCode, ignoreIssues, isExcluded, isExternal, setFactory, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hello2morrow.sonargraph.api.model.IElementAccess

getName, getNameWithSignature, getShortName, getShortNameWithSignature, ignoreIssues, isExcluded, isExternal

Methods inherited from interface com.hello2morrow.sonargraph.api.model.INamedElementAccess

getChildren, getFullyQualifiedName, getIncomingDependenciesRecursively, getIncomingDependenciesRecursively, getIssueCount, getIssueCount, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getParent, getParent, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencingElementsRecursively, getReferencingElementsRecursively

Constructor Detail

ModuleAccess

public ModuleAccess(com.hello2morrow.sonargraph.core.model.workspace.Module element)

Internal use only

Method Detail

getSourceRootDirectories

public final java.util.List<IDirectoryAccess> getSourceRootDirectories()

Specified by:

getSourceRootDirectories in interface IModuleAccess

getMetricLevel

public java.lang.Object getMetricLevel()

Description copied from class: ElementAccess

Internal use only

Overrides:

getMetricLevel in class ElementAccess<com.hello2morrow.sonargraph.core.model.workspace.Module>

getLanguage

public final java.lang.String getLanguage()

Get the language of this module.

Specified by:

getLanguage in interface IModuleAccess

Returns:

see above

getACDMetric

public java.lang.Float getACDMetric()

Specified by:

getACDMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getBiggestComponentCycleGroupMetric

public java.lang.Integer getBiggestComponentCycleGroupMetric()

Specified by:

getBiggestComponentCycleGroupMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getCCDMetric

public java.lang.Integer getCCDMetric()

Specified by:

getCCDMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getPropagationCostMetric

public java.lang.Float getPropagationCostMetric()

Specified by:

getPropagationCostMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getCodeCommentLinesMetric

public java.lang.Integer getCodeCommentLinesMetric()

Specified by:

getCodeCommentLinesMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getCommentLinesMetric

public java.lang.Integer getCommentLinesMetric()

Specified by:

getCommentLinesMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getLinesOfCodeMetric

public java.lang.Integer getLinesOfCodeMetric()

Specified by:

getLinesOfCodeMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNCCDMetric

public java.lang.Float getNCCDMetric()

Specified by:

getNCCDMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNumberOfComponentCycleGroupsMetric

public java.lang.Integer getNumberOfComponentCycleGroupsMetric()

Specified by:

getNumberOfComponentCycleGroupsMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNumberOfComponentsMetric

public java.lang.Integer getNumberOfComponentsMetric()

Specified by:

getNumberOfComponentsMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNumberOfCyclicComponentsMetric

public java.lang.Integer getNumberOfCyclicComponentsMetric()

Specified by:

getNumberOfCyclicComponentsMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNumberOfIgnoredCyclicComponentsMetric

public java.lang.Integer getNumberOfIgnoredCyclicComponentsMetric()

Specified by:

getNumberOfIgnoredCyclicComponentsMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNumberOfStatementsMetric

public java.lang.Integer getNumberOfStatementsMetric()

Specified by:

getNumberOfStatementsMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getSourceElementCountMetric

public java.lang.Integer getSourceElementCountMetric()

Specified by:

getSourceElementCountMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getTotalLinesMetric

public java.lang.Integer getTotalLinesMetric()

Specified by:

getTotalLinesMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getComponentCyclicityMetric

public java.lang.Integer getComponentCyclicityMetric()

Specified by:

getComponentCyclicityMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getComponentRelativeCyclicityMetric

public java.lang.Float getComponentRelativeCyclicityMetric()

Specified by:

getComponentRelativeCyclicityMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getComponentStructuralDebtIndexMetric

public java.lang.Integer getComponentStructuralDebtIndexMetric()

Specified by:

getComponentStructuralDebtIndexMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getComponentReferencesToCutMetric

public java.lang.Integer getComponentReferencesToCutMetric()

Specified by:

getComponentReferencesToCutMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getComponentComponentDependenciesToCutMetric

public java.lang.Integer getComponentComponentDependenciesToCutMetric()

Specified by:

getComponentComponentDependenciesToCutMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNumberOfUnassignedComponentsMetric

public java.lang.Integer getNumberOfUnassignedComponentsMetric()

Specified by:

getNumberOfUnassignedComponentsMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNumberOfComponentViolationsMetric

public java.lang.Integer getNumberOfComponentViolationsMetric()

Specified by:

getNumberOfComponentViolationsMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNumberOfViolatingComponentsMetric

public java.lang.Integer getNumberOfViolatingComponentsMetric()

Specified by:

getNumberOfViolatingComponentsMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNumberOfAllViolatingComponentsMetric

@Deprecated
public java.lang.Integer getNumberOfAllViolatingComponentsMetric()

Deprecated.

This method should no longer be used. Use the 'Parser' virtual model to obtain the unaltered metric. If you use this method the metric value might change depending on the selected virtual model.

Specified by:

getNumberOfAllViolatingComponentsMetric in interface IModuleAccess

getNumberOfParserDependencyViolationsMetric

public java.lang.Integer getNumberOfParserDependencyViolationsMetric()

Specified by:

getNumberOfParserDependencyViolationsMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getNumberOfIgnoredParserDependencyViolationsMetric

public java.lang.Integer getNumberOfIgnoredParserDependencyViolationsMetric()

Specified by:

getNumberOfIgnoredParserDependencyViolationsMetric in interface IModuleAccess

Returns:

the corresponding metric or 'null' if not available

getMaintainabilityLevelMetric

public java.lang.Float getMaintainabilityLevelMetric()

Specified by:

getMaintainabilityLevelMetric in interface IModuleAccess

accept

public void accept(INamedElementAccess.INamedElementAccessVisitor visitor)

Internal

Specified by:

accept in interface INamedElementAccess

Overrides:

accept in class ElementAccess<com.hello2morrow.sonargraph.core.model.workspace.Module>

Parameters:

visitor - The visitor implementation