com.hello2morrow.sonargraph.plugin.api

Interface ICoreAccess

All Known Subinterfaces:

ICppAccess, ICSharpAccess, IJavaAccess, IPythonAccess

public interface ICoreAccess

Root access object representing a software system

Method Summary

Modifier and Type	Method and Description
boolean	addIssue(IElementAccess element, IPluginIssueId id, java.lang.String description, int line) Add an issue to an element.
IGenericProgrammingElementAccess	createProgrammingElement(INamedElementAccess parent, IMetaClass metaClass, java.lang.String name, int line) Create a new generic programming element.
IGenericProgrammingElementAccess	createProgrammingElementComponent(INamedElementAccess parent, IMetaClass metaClass, java.lang.String name, int line) Create a new generic programming element that also is a component.
java.util.List<INamedElementAccess>	findAllMatchingElements(INamedElementAccess searchRoot, java.util.function.Predicate<INamedElementAccess> predicate) Find all elements matching the predicate.
java.util.List<IFieldAccess>	findAllMatchingFields(INamedElementAccess searchRoot, java.util.function.Predicate<IFieldAccess> predicate) Find all fields matching the predicate.
java.util.List<IMethodAccess>	findAllMatchingMethods(INamedElementAccess searchRoot, java.util.function.Predicate<IMethodAccess> predicate) Find all methods matching the predicate.
java.util.List<IRoutineAccess>	findAllMatchingRoutines(INamedElementAccess searchRoot, java.util.function.Predicate<IRoutineAccess> predicate) Find all routines matching the predicate.
java.util.List<ITypeAccess>	findAllMatchingTypes(INamedElementAccess searchRoot, java.util.function.Predicate<ITypeAccess> predicate) Find all types matching the predicate.
IElementAccess	findElementByFqn(java.lang.String fqn) Find an element by its fully qualified name.
INamedElementAccess	findFirstMatchingElement(INamedElementAccess parent, java.util.function.Predicate<INamedElementAccess> predicate) Find first child matching the predicate.
INamedElementAccess	findFirstMatchingElementRecursively(INamedElementAccess searchRoot, java.util.function.Predicate<INamedElementAccess> predicate) Recursively find first element matching the predicate.
IFieldAccess	findFirstMatchingField(INamedElementAccess searchRoot, java.util.function.Predicate<IFieldAccess> predicate) Find first field matching the predicate.
IMethodAccess	findFirstMatchingMethod(INamedElementAccess searchRoot, java.util.function.Predicate<IMethodAccess> predicate) Find first method matching the predicate.
IRoutineAccess	findFirstMatchingRoutine(INamedElementAccess searchRoot, java.util.function.Predicate<IRoutineAccess> predicate) Find first type routine the predicate.
ITypeAccess	findFirstMatchingType(INamedElementAccess searchRoot, java.util.function.Predicate<ITypeAccess> predicate) Find first type matching the predicate.
java.lang.Float	getACDMetric() Get ACD (John Lakos) metric for system scope.
java.lang.Integer	getBiggestComponentCycleGroupMetric() Get number of elements in the biggest component cycle group of the system.
java.lang.Float	getBiggestModuleACDMetric() Get the biggest ACD value (John Lakos) of all modules in the system.
java.lang.Integer	getCCDMetric() Get CCD (John Lakos) metric for system scope.
java.lang.Integer	getCodeCommentLinesMetric() Get number of code comment lines on system scope.
java.lang.Integer	getCommentLinesMetric() Get number of comment lines including header comments.
java.lang.Integer	getComponentCyclicityMetric() Get system wide component cyclicity metric.
java.lang.Integer	getComponentDependenciesToRemoveMetric() Get number of component dependencies to remove to untangle all component cycle groups.
java.lang.Integer	getComponentParserDependenciesToRemoveMetric() Get number of references between components to remove to untangle all component cycle groups.
java.lang.Float	getComponentRelativeCyclicityMetric() Get system wide relative cyclicity between components.
java.util.List<IComponentAccess>	getComponents() Gets a list of all components of the software system
java.lang.Integer	getComponentStructuralDebtIndexMetric() Get system wide structural debt index on component level.
IExternalAccess	getExternalRoot(java.lang.String forLanguage) Get the external root node for a given language
java.io.File	getHiddenDataDirectory(java.lang.String pluginId) Get hidden data directory for a plugin.
java.lang.Integer	getLinesOfCodeMetric() Get lines of codes (excluding empty lines and comment lines) on system scope.
java.util.List<IModuleAccess>	getModules() Get a list of the modules in this system
java.lang.String	getName() Return name of software system
java.lang.Float	getNCCDMetric() Get NCCD metric for system scope (John Lakos).
java.lang.Integer	getNumberOfCodeDuplicatesMetric() Get total number of non-ignored duplicated code blocks on system scope.
java.lang.Integer	getNumberOfComponentCycleGroupsMetric() Get the number of component cycle groups on system scope.
java.lang.Integer	getNumberOfComponentsMetric() Get the number of internal components in the system.
java.lang.Integer	getNumberOfComponentViolationsMetric() Get number of architecture violations between components.
java.lang.Integer	getNumberOfCyclicComponentsMetric() Get the number of internal components involved in cyclic dependencies that are not ignored.
java.lang.Integer	getNumberOfDuplicatedLinesMetric() Get total number of duplicated lines in non-ignored duplicated code blocks on system scope.
java.lang.Integer	getNumberOfIgnoredCodeDuplicatesMetric() Get total number of ignored duplicated code blocks on system scope.
java.lang.Integer	getNumberOfIgnoredCyclicComponentsMetric() Get the number of internal components involved in ignored cyclic dependencies.
java.lang.Integer	getNumberOfIgnoredParserDependencyViolationsMetric() Get number of ignored violating parser dependencies.
java.lang.Integer	getNumberOfParserDependencyViolationsMetric() Get number of violating parser dependencies.
java.lang.Integer	getNumberOfStatementsMetric() Get the total number of statements on system scope.
java.lang.Integer	getNumberOfUnassignedComponentsMetric() Get number of component not assigned to any active architectural artifact.
java.lang.Integer	getNumberOfViolatingComponentsMetric() Get number of components containing architecture violations.
java.lang.Float	getRACDMetric() Get the value of RACD for the system scope (John Lakos).
java.lang.Integer	getSourceElementCountMetric() Get the total source element count of all internal elements of the system.
java.lang.Integer	getTotalLinesMetric() Get the total number of lines in the system, including empty and comment lines.
INamedElementAccess	getWorkspaceRoot()
void	visitLogicalModuleNamespaces(ModelVisitor visitor) Visit module level logical namespaces
void	visitLogicalSystemNamespaces(ModelVisitor visitor) Visit system level logical namespaces
void	visitParserModel(ModelVisitor visitor) Visit only the parser model

Method Detail

getName

java.lang.String getName()

Return name of software system

Returns:

Name of software system

getComponents

java.util.List<IComponentAccess> getComponents()

Gets a list of all components of the software system

Returns:

Component list

getModules

java.util.List<IModuleAccess> getModules()

Get a list of the modules in this system

Returns:

Module list

getExternalRoot

IExternalAccess getExternalRoot(java.lang.String forLanguage)

Get the external root node for a given language

Parameters:

forLanguage - Language (as of now "Java", "C#" or "C/C++")

Returns:

the external root for the given language or null if it does not exist.

findElementByFqn

IElementAccess findElementByFqn(java.lang.String fqn)

Find an element by its fully qualified name.

Parameters:

fqn - The fully qualified name of the element (to be found in Sonargraphs properties view). Must not be null, empty or contain only whitespace.

Returns:

The element or null, if no element with that fully qualified name can be found.

Throws:

java.lang.IllegalArgumentException - If fqn is null, empty or contains only whitespace.

getACDMetric

java.lang.Float getACDMetric()

Get ACD (John Lakos) metric for system scope.

Returns:

see above

getBiggestComponentCycleGroupMetric

java.lang.Integer getBiggestComponentCycleGroupMetric()

Get number of elements in the biggest component cycle group of the system.

Returns:

see above

getCCDMetric

java.lang.Integer getCCDMetric()

Get CCD (John Lakos) metric for system scope.

Returns:

see above

getCodeCommentLinesMetric

java.lang.Integer getCodeCommentLinesMetric()

Get number of code comment lines on system scope.

Returns:

see above

getCommentLinesMetric

java.lang.Integer getCommentLinesMetric()

Get number of comment lines including header comments.

Returns:

see above

getLinesOfCodeMetric

java.lang.Integer getLinesOfCodeMetric()

Get lines of codes (excluding empty lines and comment lines) on system scope.

Returns:

see above

getNCCDMetric

java.lang.Float getNCCDMetric()

Get NCCD metric for system scope (John Lakos).

Returns:

see above

getNumberOfComponentCycleGroupsMetric

java.lang.Integer getNumberOfComponentCycleGroupsMetric()

Get the number of component cycle groups on system scope.

Returns:

see above

getNumberOfComponentsMetric

java.lang.Integer getNumberOfComponentsMetric()

Get the number of internal components in the system.

Returns:

see above

getNumberOfCyclicComponentsMetric

java.lang.Integer getNumberOfCyclicComponentsMetric()

Get the number of internal components involved in cyclic dependencies that are not ignored.

Returns:

see above

getNumberOfIgnoredCyclicComponentsMetric

java.lang.Integer getNumberOfIgnoredCyclicComponentsMetric()

Get the number of internal components involved in ignored cyclic dependencies.

Returns:

see above

getNumberOfStatementsMetric

java.lang.Integer getNumberOfStatementsMetric()

Get the total number of statements on system scope.

Returns:

see above

getRACDMetric

java.lang.Float getRACDMetric()

Get the value of RACD for the system scope (John Lakos).

Returns:

see above

getSourceElementCountMetric

java.lang.Integer getSourceElementCountMetric()

Get the total source element count of all internal elements of the system.

Returns:

see above

getTotalLinesMetric

java.lang.Integer getTotalLinesMetric()

Get the total number of lines in the system, including empty and comment lines.

Returns:

see above

getNumberOfCodeDuplicatesMetric

java.lang.Integer getNumberOfCodeDuplicatesMetric()

Get total number of non-ignored duplicated code blocks on system scope.

Returns:

see above

getNumberOfDuplicatedLinesMetric

java.lang.Integer getNumberOfDuplicatedLinesMetric()

Get total number of duplicated lines in non-ignored duplicated code blocks on system scope.

Returns:

see above

getNumberOfIgnoredCodeDuplicatesMetric

java.lang.Integer getNumberOfIgnoredCodeDuplicatesMetric()

Get total number of ignored duplicated code blocks on system scope.

Returns:

see above

getBiggestModuleACDMetric

java.lang.Float getBiggestModuleACDMetric()

Get the biggest ACD value (John Lakos) of all modules in the system.

Returns:

see above

getComponentCyclicityMetric

java.lang.Integer getComponentCyclicityMetric()

Get system wide component cyclicity metric.

Returns:

see above

getComponentRelativeCyclicityMetric

java.lang.Float getComponentRelativeCyclicityMetric()

Get system wide relative cyclicity between components.

Returns:

see above

getComponentStructuralDebtIndexMetric

java.lang.Integer getComponentStructuralDebtIndexMetric()

Get system wide structural debt index on component level.

Returns:

see above

getComponentParserDependenciesToRemoveMetric

java.lang.Integer getComponentParserDependenciesToRemoveMetric()

Get number of references between components to remove to untangle all component cycle groups.

Returns:

see above

getComponentDependenciesToRemoveMetric

java.lang.Integer getComponentDependenciesToRemoveMetric()

Get number of component dependencies to remove to untangle all component cycle groups.

Returns:

see above

getNumberOfUnassignedComponentsMetric

java.lang.Integer getNumberOfUnassignedComponentsMetric()

Get number of component not assigned to any active architectural artifact. (Architecture feature needed)

Returns:

see above

getNumberOfComponentViolationsMetric

java.lang.Integer getNumberOfComponentViolationsMetric()

Get number of architecture violations between components. (Architecture feature needed)

Returns:

see above

getNumberOfViolatingComponentsMetric

java.lang.Integer getNumberOfViolatingComponentsMetric()

Get number of components containing architecture violations. (Architecture feature needed)

Returns:

see above

getNumberOfParserDependencyViolationsMetric

java.lang.Integer getNumberOfParserDependencyViolationsMetric()

Get number of violating parser dependencies. (Architecture feature needed)

Returns:

see above

getNumberOfIgnoredParserDependencyViolationsMetric

java.lang.Integer getNumberOfIgnoredParserDependencyViolationsMetric()

Get number of ignored violating parser dependencies. (Architecture feature needed)

Returns:

see above

findFirstMatchingType

ITypeAccess findFirstMatchingType(INamedElementAccess searchRoot,
                                  java.util.function.Predicate<ITypeAccess> predicate)

Find first type matching the predicate.

Parameters:

searchRoot - Element from where to begin the search or null if whole system is to be searched.

predicate - The predicate to match the type, must not be null.

Returns:

The matching type or null if there is no matching type.

findAllMatchingTypes

java.util.List<ITypeAccess> findAllMatchingTypes(INamedElementAccess searchRoot,
                                                 java.util.function.Predicate<ITypeAccess> predicate)

Find all types matching the predicate.

Parameters:

searchRoot - Element from where to begin the search or null if whole system is to be searched.

predicate - The predicate to match the types, must not be null.

Returns:

A list of types matching the predicate (can be empty).

findFirstMatchingMethod

IMethodAccess findFirstMatchingMethod(INamedElementAccess searchRoot,
                                      java.util.function.Predicate<IMethodAccess> predicate)

Find first method matching the predicate.

Parameters:

searchRoot - Element from where to begin the search, or null to use 'Workspace' as root.

predicate - The predicate to match the method, must not be null.

Returns:

The matching type or null if there is no matching method.

findAllMatchingMethods

java.util.List<IMethodAccess> findAllMatchingMethods(INamedElementAccess searchRoot,
                                                     java.util.function.Predicate<IMethodAccess> predicate)

Find all methods matching the predicate.

Parameters:

searchRoot - Element from where to begin the search, or null to use 'Workspace' as root.

predicate - The predicate to match the methods, must not be null.

Returns:

A list of methods matching the predicate (can be empty).

findFirstMatchingRoutine

IRoutineAccess findFirstMatchingRoutine(INamedElementAccess searchRoot,
                                        java.util.function.Predicate<IRoutineAccess> predicate)

Find first type routine the predicate.

Parameters:

searchRoot - Element from where to begin the search, or null to use 'Workspace' as root.

predicate - The predicate to match the routine, must not be null.

Returns:

The matching type or null if there is no matching routine.

findAllMatchingRoutines

java.util.List<IRoutineAccess> findAllMatchingRoutines(INamedElementAccess searchRoot,
                                                       java.util.function.Predicate<IRoutineAccess> predicate)

Find all routines matching the predicate.

Parameters:

searchRoot - Element from where to begin the search, or null to use 'Workspace' as root.

predicate - The predicate to match the routines, must not be null.

Returns:

A list of routines matching the predicate (can be empty).

findFirstMatchingField

IFieldAccess findFirstMatchingField(INamedElementAccess searchRoot,
                                    java.util.function.Predicate<IFieldAccess> predicate)

Find first field matching the predicate.

Parameters:

searchRoot - Element from where to begin the search, or null to use 'Workspace' as root.

predicate - The predicate to match the field, must not be null.

Returns:

The matching field or null if there is no matching field.

findAllMatchingFields

java.util.List<IFieldAccess> findAllMatchingFields(INamedElementAccess searchRoot,
                                                   java.util.function.Predicate<IFieldAccess> predicate)

Find all fields matching the predicate.

Parameters:

searchRoot - Element from where to begin the search, or null to use 'Workspace' as root.

predicate - The predicate to match the fields, must not be null.

Returns:

A list of fields matching the predicate (can be empty).

findFirstMatchingElement

INamedElementAccess findFirstMatchingElement(INamedElementAccess parent,
                                             java.util.function.Predicate<INamedElementAccess> predicate)

Find first child matching the predicate.

Parameters:

parent - Parent element to search for a child, or null to use 'Workspace' as parent.

predicate - The predicate to match the element, must not be null.

Returns:

The matching element or null if there is no matching element.

findFirstMatchingElementRecursively

INamedElementAccess findFirstMatchingElementRecursively(INamedElementAccess searchRoot,
                                                        java.util.function.Predicate<INamedElementAccess> predicate)

Recursively find first element matching the predicate.

Parameters:

searchRoot - Element from where to begin the search or null if whole system is to be searched.

predicate - The predicate to match the element, must not be null.

Returns:

The matching element or null if there is no matching element.

findAllMatchingElements

java.util.List<INamedElementAccess> findAllMatchingElements(INamedElementAccess searchRoot,
                                                            java.util.function.Predicate<INamedElementAccess> predicate)

Find all elements matching the predicate.

Parameters:

searchRoot - Element from where to begin the search, or null to use 'Workspace' as root.

predicate - The predicate to match the element, must not be null.

Returns:

A list of elements matching the predicate (can be empty).

getWorkspaceRoot

INamedElementAccess getWorkspaceRoot()

visitParserModel

void visitParserModel(ModelVisitor visitor)

Visit only the parser model

Parameters:

visitor - the visitor

visitLogicalModuleNamespaces

void visitLogicalModuleNamespaces(ModelVisitor visitor)

Visit module level logical namespaces

Parameters:

visitor - the visitor

visitLogicalSystemNamespaces

void visitLogicalSystemNamespaces(ModelVisitor visitor)

Visit system level logical namespaces

Parameters:

visitor - the visitor

createProgrammingElement

IGenericProgrammingElementAccess createProgrammingElement(INamedElementAccess parent,
                                                          IMetaClass metaClass,
                                                          java.lang.String name,
                                                          int line)

Create a new generic programming element.

Parameters:

parent - The parent element

metaClass - Meta class

name - Element name

line - Line number or -1 if unknown

Returns:

An access object for the new element.

createProgrammingElementComponent

IGenericProgrammingElementAccess createProgrammingElementComponent(INamedElementAccess parent,
                                                                   IMetaClass metaClass,
                                                                   java.lang.String name,
                                                                   int line)

Create a new generic programming element that also is a component.

Parameters:

parent - The parent element

metaClass - Meta class

name - Element name

line - Line number or -1 if unknown

Returns:

An access object for the new element.

addIssue

boolean addIssue(IElementAccess element,
                 IPluginIssueId id,
                 java.lang.String description,
                 int line)

Add an issue to an element.

Parameters:

element - The element associated with the issue

id - Issue specific id, should be equal for all issues of the same kind

description - Issue description (can be null)

line - Line number or 0 or negative when unknown

Returns:

true, if issue is not ignored

getHiddenDataDirectory

java.io.File getHiddenDataDirectory(java.lang.String pluginId)

Get hidden data directory for a plugin.

Parameters:

pluginId - plugin id, must not be null or empty.

Returns:

hidden data directory for plugin id, or null if it could't be created