ModuleAccess

java.lang.Object
- com.hello2morrow.sonargraph.core.controller.system.script.ElementAccess<Module>
- - com.hello2morrow.sonargraph.core.controller.system.script.ModuleAccess

All Implemented Interfaces:

IElementAccess, IModuleAccess, INamedElementAccess

Direct Known Subclasses:

CppModuleAccess, CSharpModuleAccess, JavaModuleAccess, PythonModuleAccess
```
public class ModuleAccess
extends ElementAccess<Module>
implements IModuleAccess
```
Access class for parse model modules.

Nested Class Summary
- Nested classes/interfaces inherited from class com.hello2morrow.sonargraph.core.controller.system.script.ElementAccess
  ElementAccess.IAccessFactory
- Nested classes/interfaces inherited from interface com.hello2morrow.sonargraph.plugin.api.IModuleAccess
  IModuleAccess.IVisitor
- Nested classes/interfaces inherited from interface com.hello2morrow.sonargraph.plugin.api.INamedElementAccess
  INamedElementAccess.INamedElementAccessVisitor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and 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.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.Float`	`getRACDMetric()`
`java.lang.Integer`	`getSourceElementCountMetric()`
`java.util.List<IDirectoryAccess>`	`getSourceRootDirectories()`
`java.lang.Integer`	`getTotalLinesMetric()`

Methods inherited from class com.hello2morrow.sonargraph.core.controller.system.script.ElementAccess
equals, getChildren, getElement, getIncomingDependenciesRecursively, getIncomingDependenciesRecursively, getName, getNameWithSignature, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getParent, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencingElementsRecursively, getReferencingElementsRecursively, getShortName, getShortNameWithSignature, hashCode, ignoreIssues, isExcluded, isExternal, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hello2morrow.sonargraph.plugin.api.INamedElementAccess
getChildren, getIncomingDependenciesRecursively, getIncomingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getParent, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencingElementsRecursively, getReferencingElementsRecursively

Methods inherited from interface com.hello2morrow.sonargraph.plugin.api.IElementAccess
getName, getNameWithSignature, getShortName, getShortNameWithSignature, ignoreIssues, isExcluded, isExternal

- Method Detail
  - getSourceRootDirectories
```
public java.util.List<IDirectoryAccess> getSourceRootDirectories()
```
    Specified by:
    
    getSourceRootDirectories in interface IModuleAccess
  - 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()
```
    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
  - getRACDMetric
```
public java.lang.Float getRACDMetric()
```
    Specified by:
    
    getRACDMetric 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
    
    Returns:
    
    getNumberOfViolatingComponentsMetric().
  - 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<Module>
    
    Parameters:
    
    visitor - The visitor implementation

Sonargraph Script and Plugin API

Class ModuleAccess

Nested Class Summary

Nested classes/interfaces inherited from class com.hello2morrow.sonargraph.core.controller.system.script.ElementAccess

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

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

Method Summary

Methods inherited from class com.hello2morrow.sonargraph.core.controller.system.script.ElementAccess

Methods inherited from class java.lang.Object

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

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

Method Detail

getSourceRootDirectories

getLanguage

getACDMetric

getBiggestComponentCycleGroupMetric

getCCDMetric

getPropagationCostMetric

getCodeCommentLinesMetric

getCommentLinesMetric

getLinesOfCodeMetric

getNCCDMetric

getNumberOfComponentCycleGroupsMetric

getNumberOfComponentsMetric

getNumberOfCyclicComponentsMetric

getNumberOfIgnoredCyclicComponentsMetric

getNumberOfStatementsMetric

getRACDMetric

getSourceElementCountMetric

getTotalLinesMetric

getComponentCyclicityMetric

getComponentRelativeCyclicityMetric

getComponentStructuralDebtIndexMetric

getComponentReferencesToCutMetric

getComponentComponentDependenciesToCutMetric

getNumberOfUnassignedComponentsMetric

getNumberOfComponentViolationsMetric

getNumberOfViolatingComponentsMetric

getNumberOfAllViolatingComponentsMetric

getNumberOfParserDependencyViolationsMetric

getNumberOfIgnoredParserDependencyViolationsMetric

getMaintainabilityLevelMetric

accept