Package com.hello2morrow.sonargraph.api.model

Interface INamedElementAccess

All Superinterfaces:

IElementAccess

All Known Subinterfaces:

ICppSourceFileAccess, IDirectoryAccess, IExternalAccess, IFieldAccess, IGenericClassAccess, IGenericFieldAccess, IGenericFunctionAccess, IGenericMethodAccess, IGenericProgrammingElementAccess, IJavaClassFileAccess, IJavaFieldAccess, IJavaLogicalModuleAccess, IJavaLogicalPackageAccess, IJavaMethodAccess, IJavaModuleAccess, IJavaSourceFileAccess, IJavaSyntheticTypeAccess, IJavaTypeAccess, ILogicalExternalAccess, ILogicalModuleAccess, ILogicalNamespaceAccess, ILogicalProgrammingElementAccess, ILogicalSystemAccess, IMethodAccess, IModuleAccess, INamespaceFragmentAccess, IProgrammingElementAccess, IPythonClassAccess, IPythonExternalAccess, IPythonFieldAccess, IPythonFunctionAccess, IPythonMethodAccess, IPythonModuleAccess, IPythonSourceFileAccess, IPythonVariableAccess, IRoutineAccess, ISourceFileAccess, ITypeAccess

All Known Implementing Classes:

AggregatedDependencyAccess, CppClassAccess, CppCompilationUnitFragmentAccess, CppComponentAccess, CppDirectoryFragmentAccess, CppEnumAccess, CppEnumConstantAccess, CppFieldAccess, CppFunctionAccess, CppIncludeDirectoryAccess, CppLogicalModuleAccess, CppLogicalNamespaceAccess, CppMacroAccess, CppMacroInvocationAccess, CppMethodAccess, CppModuleAccess, CppRootDirectoryPathAccess, CppSourceFileAccess, CppStructAccess, CppStructuredTypeAccess, CppTypeAccess, CppUnionAccess, CppVariableAccess, CppWeakRootDirectoryAccess, CSharpClassAccess, CSharpDelegateAccess, CSharpEnumAccess, CSharpEnumConstantAccess, CSharpEventAccess, CSharpFieldAccess, CSharpInterfaceAccess, CSharpLogicalModuleAccess, CSharpLogicalNamespaceAccess, CSharpMethodAccess, CSharpModuleAccess, CSharpPropertyAccess, CSharpSourceFileAccess, CSharpStructAccess, CSharpTypeAccess, DependencyAccess, DirectoryAccess, DirectoryFragmentAccess, ElementAccess, ExternalAccess, ExternalElementContainerAccess, FieldAccess, GenericClassAccess, GenericFieldAccess, GenericFunctionAccess, GenericMethodAccess, JavaClassFileAccess, JavaFieldAccess, JavaLogicalModuleAccess, JavaLogicalPackageAccess, JavaMethodAccess, JavaModuleAccess, JavaSourceFileAccess, JavaSyntheticTypeAccess, JavaTypeAccess, LogicalExternalAccess, LogicalModuleAccess, LogicalModuleProgrammingElementAccess, LogicalNamespaceAccess, LogicalProgrammingElementAccess, LogicalSystemAccess, LogicalSystemProgrammingElementAccess, MethodAccess, ModuleAccess, NamespaceFragmentAccess, PluginProgrammingElementAccess, ProgrammingElementAccess, PythonClassAccess, PythonExternalAccess, PythonFieldAccess, PythonFunctionAccess, PythonMethodAccess, PythonModuleAccess, PythonSourceFileAccess, PythonVariableAccess, RootAccess, RoutineAccess, SourceFileAccess, TypeAccess

public interface INamedElementAccess
extends IElementAccess

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	INamedElementAccess.INamedElementAccessVisitor

Method Summary

Modifier and Type	Method	Description
void	accept(INamedElementAccess.INamedElementAccessVisitor visitor)	Visit this element.
java.util.List<? extends INamedElementAccess>	getChildren()	Provides access to the children.
java.lang.String	getFullyQualifiedName()
java.util.List<IAggregatedDependencyAccess>	getIncomingDependenciesRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExcluded, IDependencyKind... types)	Compute the incoming aggregated dependencies of this element and all its children.
java.util.List<IAggregatedDependencyAccess>	getIncomingDependenciesRecursively(Aggregator aggr, boolean excludeSelf, IDependencyKind... types)	Compute the incoming aggregated dependencies of this element and all its children, excluding excluded elements.
default int	getIssueCount(java.lang.String category, java.lang.String id, java.lang.String provider, java.lang.String severity, boolean recursive)	Counts total number of issues for this element for the given filter parameters.
int	getIssueCount(java.util.List<java.lang.String> categories, java.util.List<java.lang.String> issueIds, java.util.List<java.lang.String> providers, java.util.List<java.lang.String> severities, boolean recursive)	Counts total number of issues for this element for the given filter parameters.
java.util.List<IAggregatedDependencyAccess>	getOutgoingDependenciesRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExternals, boolean excludeExcluded, IDependencyKind... types)	Compute the outgoing aggregated dependencies of this element and all its children.
java.util.List<IAggregatedDependencyAccess>	getOutgoingDependenciesRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExternals, IDependencyKind... types)	Compute the outgoing aggregated dependencies of this element and all its children, excluding excluded elements.
java.util.List<IAggregatedDependencyAccess>	getOutgoingDependenciesRecursively(Aggregator aggr, boolean excludeSelf, IDependencyKind... types)	Compute the outgoing aggregated dependencies of this element and all its children, including external elements, excluding excluded elements.
INamedElementAccess	getParent()	Provides access to the parent.
<T extends INamedElementAccess> T	getParent(java.lang.Class<T> clazz)
java.util.List<INamedElementAccess>	getReferencedElementsRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExternals, boolean excludeExcluded, IDependencyKind... types)	Compute the list of referenced elements of this element and all its children.
java.util.List<INamedElementAccess>	getReferencedElementsRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExternals, IDependencyKind... types)	Compute the list of referenced elements of this element and all its children, excluding excluded elements.
java.util.List<INamedElementAccess>	getReferencedElementsRecursively(Aggregator aggr, boolean excludeSelf, IDependencyKind... types)	Compute the list of referenced elements of this element and all its children, including external elements, excluding excluded elements.
java.util.List<INamedElementAccess>	getReferencingElementsRecursively(Aggregator aggr, boolean excludeSelf, boolean excludeExcluded, IDependencyKind... types)	Get a list of all elements referencing this element and its children.
java.util.List<INamedElementAccess>	getReferencingElementsRecursively(Aggregator aggr, boolean excludeSelf, IDependencyKind... types)	Get a list of all elements referencing this element and its children, excluding excluded elements.

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

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

Method Detail

getParent

INamedElementAccess getParent()

Provides access to the parent.

Returns:

the parent or 'null' if there is no parent.

getChildren

java.util.List<? extends INamedElementAccess> getChildren()

Provides access to the children.

Returns:

List of children (might be empty).

getIssueCount

default int getIssueCount(java.lang.String category,
                          java.lang.String id,
                          java.lang.String provider,
                          java.lang.String severity,
                          boolean recursive)

Counts total number of issues for this element for the given filter parameters.

Parameters:

category - A category or null, if you want to match all categories

id - An issue id or null, if you want to match all id's

provider - A provider or null, if you want to match all providers

severity - A severity or null, if you want to match all severities

recursive - Add direct and indirect children's issues to count

Returns:

Total number of issues matching the filter criteria

getIssueCount

int getIssueCount(java.util.List<java.lang.String> categories,
                  java.util.List<java.lang.String> issueIds,
                  java.util.List<java.lang.String> providers,
                  java.util.List<java.lang.String> severities,
                  boolean recursive)

Counts total number of issues for this element for the given filter parameters.

Parameters:

categories - Issue categories (empty list means 'all")

issueIds - Issue Id's (empty list mean all, listed under issue type in properties vieww)

providers - Issue providers (empty list means 'all")

severities - Issue severities (empty list means 'all")

recursive - Add direct and indirect children's issues to count

Returns:

Total number of issues matching the filter criteria

getOutgoingDependenciesRecursively

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

Compute the outgoing aggregated dependencies of this element and all its children.

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

getOutgoingDependenciesRecursively

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

Compute the outgoing aggregated dependencies of this element and all its children, excluding excluded elements.

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

getOutgoingDependenciesRecursively

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

Compute the outgoing aggregated dependencies of this element and all its children, including external elements, excluding excluded elements.

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

getIncomingDependenciesRecursively

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

Compute the incoming aggregated dependencies of this element and all its children.

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

getIncomingDependenciesRecursively

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

Compute the incoming aggregated dependencies of this element and all its children, excluding excluded elements.

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

getReferencedElementsRecursively

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

Compute the list of referenced elements of this element and all its children.

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

getReferencedElementsRecursively

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

Compute the list of referenced elements of this element and all its children, excluding excluded elements.

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

getReferencedElementsRecursively

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

Compute the list of referenced elements of this element and all its children, including external elements, excluding excluded elements.

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

getReferencingElementsRecursively

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

Get a list of all elements referencing this element and its children.

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.

getReferencingElementsRecursively

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

Get a list of all elements referencing this element and its children, excluding excluded elements.

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.

accept

void accept(INamedElementAccess.INamedElementAccessVisitor visitor)

Visit this element.

Parameters:

visitor - The visitor implementation

getFullyQualifiedName

java.lang.String getFullyQualifiedName()

Returns:

the fully qualified name as shown in the Sonargraph properties view

getParent

<T extends INamedElementAccess> T getParent(java.lang.Class<T> clazz)

Parameters:

clazz - class of the parent.

Returns:

the first matching parent of this element matching the given class or null if no parent exists or no parent of the specified class exists.