com.hello2morrow.sonargraph.plugin.api

Interface ILogicalNamespaceAccess

All Superinterfaces:

IElementAccess, INamedElementAccess

All Known Subinterfaces:

IJavaLogicalPackageAccess

All Known Implementing Classes:

CppLogicalNamespaceAccess, CSharpLogicalNamespaceAccess, JavaLogicalPackageAccess, LogicalNamespaceAccess

public interface ILogicalNamespaceAccess
extends INamedElementAccess

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ILogicalNamespaceAccess.IVisitor

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

INamedElementAccess.INamedElementAccessVisitor

Method Summary

Modifier and Type	Method and Description
java.lang.Float	getAbstractnessMetric()
java.lang.Float	getDistanceMetric()
java.util.List<IAggregatedDependencyAccess>	getIncomingDependenciesFlatRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExcluded, IDependencyKind... types) Compute the incoming aggregated dependencies of this element and all its children, but treats this namespace as "flat", i.e.
java.util.List<IAggregatedDependencyAccess>	getIncomingDependenciesFlatRecursively(Aggregator aggr, boolean excludeSelf, IDependencyKind... types) Compute the incoming aggregated dependencies of this element and all its children, but treats this namespace as "flat", i.e.
java.lang.Float	getInstabilityMetric()
IModuleAccess	getModuleScope()
java.lang.Integer	getNumberOfIncomingDependenciesMetric()
java.lang.Integer	getNumberOfOutgoingDependenciesMetric()
java.lang.Integer	getNumberOfTypesMetric()
java.util.List<IAggregatedDependencyAccess>	getOutgoingDependenciesFlatRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExternals, boolean excludeExcluded, IDependencyKind... types) Compute the outgoing aggregated dependencies of this element and all its children, but treats this namespace as "flat", i.e.
java.util.List<IAggregatedDependencyAccess>	getOutgoingDependenciesFlatRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExternals, IDependencyKind... types) Compute the outgoing aggregated dependencies of this element and all its children, but treats this namespace as "flat", i.e.
java.util.List<IAggregatedDependencyAccess>	getOutgoingDependenciesFlatRecursively(Aggregator aggr, boolean excludeSelf, IDependencyKind... types) Compute the outgoing aggregated dependencies of this element and all its children, but treats this namespace as "flat", i.e.
java.util.List<IProgrammingElementAccess>	getProgrammingElements()
java.util.List<INamedElementAccess>	getReferencedElementsFlatRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExternals, boolean excludeExcluded, IDependencyKind... types) Compute the list of referenced elements of this element and all its children, but treats this namespace as "flat", i.e.
java.util.List<INamedElementAccess>	getReferencedElementsFlatRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExternals, IDependencyKind... types) Compute the list of referenced elements of this element and all its children, but treats this namespace as "flat", i.e.
java.util.List<INamedElementAccess>	getReferencedElementsFlatRecursively(Aggregator aggr, boolean excludeSelf, IDependencyKind... types) Compute the list of referenced elements of this element and all its children, but treats this namespace as "flat", i.e.
java.util.List<INamedElementAccess>	getReferencingElementsFlatRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExcluded, IDependencyKind... types) Get a list of all elements referencing this element and its children, but treats this namespace as "flat", i.e.
java.util.List<INamedElementAccess>	getReferencingElementsFlatRecursively(Aggregator aggr, boolean excludeSelf, IDependencyKind... types) Get a list of all elements referencing this element and its children, but treats this namespace as "flat", i.e.
boolean	isPart()
boolean	isSystemScope()

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

accept, 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

getOutgoingDependenciesFlatRecursively

java.util.List<IAggregatedDependencyAccess> getOutgoingDependenciesFlatRecursively(Aggregator aggr,
                                                                                   boolean excludeSelf,
                                                                                   boolean excludeExternals,
                                                                                   boolean excludeExcluded,
                                                                                   IDependencyKind... types)

Compute the outgoing aggregated dependencies of this element and all its children, but treats this namespace as "flat", i.e. does not include any child namespaces.

Parameters:

aggr - The desired level of aggregation

excludeSelf - If true, exclude all dependencies targeting this object or its children

excludeExternals - If true, exclude all dependencies targeting external objects.

excludeExcluded - If true, exclude all dependencies targeting excluded objects.

types - List of dependency types (if empty, all dependencies will be returned)

Returns:

List of dependencies aggregated to the desired level

getOutgoingDependenciesFlatRecursively

java.util.List<IAggregatedDependencyAccess> getOutgoingDependenciesFlatRecursively(Aggregator aggr,
                                                                                   boolean excludeSelf,
                                                                                   boolean excludeExternals,
                                                                                   IDependencyKind... types)

Compute the outgoing aggregated dependencies of this element and all its children, but treats this namespace as "flat", i.e. does not include any child namespaces.

Parameters:

aggr - The desired level of aggregation

excludeSelf - If true, exclude all dependencies targeting this object or its children

excludeExternals - If true, exclude all dependencies targeting external objects.

types - List of dependency types (if empty, all dependencies will be returned)

Returns:

List of dependencies aggregated to the desired level

getOutgoingDependenciesFlatRecursively

java.util.List<IAggregatedDependencyAccess> getOutgoingDependenciesFlatRecursively(Aggregator aggr,
                                                                                   boolean excludeSelf,
                                                                                   IDependencyKind... types)

Compute the outgoing aggregated dependencies of this element and all its children, but treats this namespace as "flat", i.e. does not include any child namespaces.

Parameters:

aggr - The desired level of aggregation

excludeSelf - If true, exclude all dependencies targeting this object or its children

types - List of dependency types (if empty, all dependencies will be returned)

Returns:

List of dependencies aggregated to the desired level

getIncomingDependenciesFlatRecursively

java.util.List<IAggregatedDependencyAccess> getIncomingDependenciesFlatRecursively(Aggregator aggr,
                                                                                   boolean excludeSelf,
                                                                                   boolean excludeExcluded,
                                                                                   IDependencyKind... types)

Compute the incoming aggregated dependencies of this element and all its children, but treats this namespace as "flat", i.e. does not include any child namespaces.

Parameters:

aggr - The desired level of aggregation

excludeSelf - If true, exclude all dependencies coming from this object or its children

excludeExcluded - If true, exclude all dependencies coming from excluded elements

types - List of dependency types (if empty, all dependencies will be returned)

Returns:

List of incoming dependencies aggregated to the desired level

getIncomingDependenciesFlatRecursively

java.util.List<IAggregatedDependencyAccess> getIncomingDependenciesFlatRecursively(Aggregator aggr,
                                                                                   boolean excludeSelf,
                                                                                   IDependencyKind... types)

Compute the incoming aggregated dependencies of this element and all its children, but treats this namespace as "flat", i.e. does not include any child namespaces.

Parameters:

aggr - The desired level of aggregation

excludeSelf - If true, exclude all dependencies coming from this object or its children

types - List of dependency types (if empty, all dependencies will be returned)

Returns:

List of incoming dependencies aggregated to the desired level

getReferencingElementsFlatRecursively

java.util.List<INamedElementAccess> getReferencingElementsFlatRecursively(Aggregator aggr,
                                                                          boolean excludeSelf,
                                                                          boolean excludeExcluded,
                                                                          IDependencyKind... types)

Get a list of all elements referencing this element and its children, but treats this namespace as "flat", i.e. does not include any child namespaces.

Parameters:

aggr - The desired level of aggregation

excludeSelf - If true, exclude this object and its children from the resulting list

excludeExcluded - If true, exclude all excluded objects.

types - List of dependency types (if empty, all dependencies will be returned)

Returns:

List of referencing objects according to the aggregation level.

getReferencingElementsFlatRecursively

java.util.List<INamedElementAccess> getReferencingElementsFlatRecursively(Aggregator aggr,
                                                                          boolean excludeSelf,
                                                                          IDependencyKind... types)

Get a list of all elements referencing this element and its children, but treats this namespace as "flat", i.e. does not include any child namespaces.

Parameters:

aggr - The desired level of aggregation

excludeSelf - If true, exclude this object and its children from the resulting list

types - List of dependency types (if empty, all dependencies will be returned)

Returns:

List of referencing objects according to the aggregation level.

getReferencedElementsFlatRecursively

java.util.List<INamedElementAccess> getReferencedElementsFlatRecursively(Aggregator aggr,
                                                                         boolean excludeSelf,
                                                                         boolean excludeExternals,
                                                                         boolean excludeExcluded,
                                                                         IDependencyKind... types)

Compute the list of referenced elements of this element and all its children, but treats this namespace as "flat", i.e. does not include any child namespaces.

Parameters:

aggr - The desired level of aggregation

excludeSelf - If true, exclude this object and its children from the resulting list

excludeExternals - If true, exclude all external objects.

excludeExcluded - If true, exclude all excluded objects.

types - List of dependency types (if empty, all dependencies will be returned)

Returns:

List of referenced objects according to the aggregation level

getReferencedElementsFlatRecursively

java.util.List<INamedElementAccess> getReferencedElementsFlatRecursively(Aggregator aggr,
                                                                         boolean excludeSelf,
                                                                         boolean excludeExternals,
                                                                         IDependencyKind... types)

Compute the list of referenced elements of this element and all its children, but treats this namespace as "flat", i.e. does not include any child namespaces.

Parameters:

aggr - The desired level of aggregation

excludeSelf - If true, exclude this object and its children from the resulting list

excludeExternals - If true, exclude all external objects.

types - List of dependency types (if empty, all dependencies will be returned)

Returns:

List of referenced objects according to the aggregation level

getReferencedElementsFlatRecursively

java.util.List<INamedElementAccess> getReferencedElementsFlatRecursively(Aggregator aggr,
                                                                         boolean excludeSelf,
                                                                         IDependencyKind... types)

Compute the list of referenced elements of this element and all its children, but treats this namespace as "flat", i.e. does not include any child namespaces.

Parameters:

aggr - The desired level of aggregation

excludeSelf - If true, exclude this object and its children from the resulting list

types - List of dependency types (if empty, all dependencies will be returned)

Returns:

List of referenced objects according to the aggregation level

getNumberOfOutgoingDependenciesMetric

java.lang.Integer getNumberOfOutgoingDependenciesMetric()

getNumberOfIncomingDependenciesMetric

java.lang.Integer getNumberOfIncomingDependenciesMetric()

getInstabilityMetric

java.lang.Float getInstabilityMetric()

getDistanceMetric

java.lang.Float getDistanceMetric()

getNumberOfTypesMetric

java.lang.Integer getNumberOfTypesMetric()

getAbstractnessMetric

java.lang.Float getAbstractnessMetric()

getProgrammingElements

java.util.List<IProgrammingElementAccess> getProgrammingElements()

isPart

boolean isPart()

isSystemScope

boolean isSystemScope()

getModuleScope

IModuleAccess getModuleScope()