com.atlassian.clover.registry.entities

Class FullProjectInfo

java.lang.Object

com.atlassian.clover.registry.entities.BaseProjectInfo

com.atlassian.clover.registry.entities.FullProjectInfo

All Implemented Interfaces:

EntityContainer, HasContextFilter, HasMetrics, HasPackages, ProjectInfo, CachingInfo, CoverageDataRange, CoverageDataReceptor, HasMetricsNode

public class FullProjectInfo
extends BaseProjectInfo
implements HasMetricsNode, CoverageDataReceptor, ProjectInfo

A model of a java project. The model is built at instrumentation time and can then be queried to generate reports.

Instrumentation time

The project model is updated via the various add*() methods. The project must be versioned using setVersion() at the start of each instrumentation session. @see Clover2Registry.

Reporting time

The main entry points to project hierachy are the getPackages(), getPackages(HasMetricsFilter) methods, which return arrays of FullPackageInfos for the project.

Several convenience methods are provided to enable fast lookup of entities in the project, using lazily built data structures:

• getPackageRoots() returns a tree of PackageFragments representing the (possibly) non-concrete packages in the project.
• findClass() finds a ClassInfo in the project given its fully qualified name.
• hasTestHits(HasMetricsNode), getTestHits(HasMetricsNode), and getTestMethod(int) gets information on which tests hit a given entity in the project.

Metrics for the project are available via getMetrics(). Note that the returned BlockMetrics should be cast to a ProjectMetrics to access project-level metrics. Before querying coverage related metrics on the project or its children, you must set a CoverageDataProvider (otherwise all coverage-related metrics will return 0).

A call to setDataProvider() forces metrics for the project and all children to be lazily recalculated.

Note: The setComparator() method only affects the order of project elements returned via the HasMetricsNode interface

Note: The serialized version of this class is used in the stored version of the Clover2Registry. Care must be taken when adding non-transient fields to this class, because they could potentially break compatibility with existing registry files.

Field Summary

Fields inherited from class com.atlassian.clover.registry.entities.BaseProjectInfo

classLookup, contextFilter, fileLookup, metrics, name, packages, rawMetrics, version

Constructor Summary

Constructors

Constructor and Description
FullProjectInfo(String name)
FullProjectInfo(String name, long version)

Method Summary

Modifier and Type	Method and Description
void	buildCaches()
FullProjectInfo	copy()
FullProjectInfo	copy(HasMetricsFilter filter) create a deep copy of this project tree, applying the filter to all levels
FullProjectInfo	copy(HasMetricsFilter filter, ContextSet contextFilter) create a deep copy of this project tree, applying the filter and context set to all levels
PackageInfo	findPackage(String name) Searches for a package with given name
PackageFragment	findPackageFragment(String packageName)
HasMetricsNode	getChild(int i)
String	getChildType()
int	getDataIndex()
int	getDataLength()
CoverageDataProvider	getDataProvider()
int	getIndexOfChild(HasMetricsNode child)
BlockMetrics	getMetrics()
int	getNumChildren()
PackageFragment[]	getPackageRoots()
BlockMetrics	getRawMetrics()
boolean	hasTestResults()
void	invalidateCaches()
boolean	isFragmented()
boolean	isLeaf()
void	resolve(Path sourcePath)
void	setComparator(Comparator cmp)
void	setDataLength(int length)
void	setDataProvider(CoverageDataProvider data)
void	setFragmented(boolean fragmented)
void	setHasTestResults(boolean hasTestResults)
void	setVersion(long version)

Methods inherited from class com.atlassian.clover.registry.entities.BaseProjectInfo

addPackage, findClass, findFile, getAllPackages, getClasses, getContextFilter, getDefaultPackage, getFiles, getName, getNamedPackage, getPackages, getVersion, isEmpty, setContextFilter, setMetrics, setName, visit, visitFiles

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.clover.registry.metrics.HasMetricsNode

isEmpty

Methods inherited from interface com.atlassian.clover.api.registry.ProjectInfo

findClass, findFile, getName, isEmpty

Methods inherited from interface com.atlassian.clover.api.registry.EntityContainer

visit

Methods inherited from interface com.atlassian.clover.api.registry.HasPackages

getAllPackages

Methods inherited from interface com.atlassian.clover.api.registry.HasContextFilter

getContextFilter

Methods inherited from interface com.atlassian.clover.api.registry.HasMetrics

setMetrics

Constructor Detail

FullProjectInfo

public FullProjectInfo(String name,
                       long version)

FullProjectInfo

public FullProjectInfo(String name)

Method Detail

getPackageRoots

public PackageFragment[] getPackageRoots()

copy

public FullProjectInfo copy()

copy

public FullProjectInfo copy(HasMetricsFilter filter)

create a deep copy of this project tree, applying the filter to all levels

Returns:

filtered copy of the projectinfo

copy

public FullProjectInfo copy(HasMetricsFilter filter,
                            ContextSet contextFilter)

create a deep copy of this project tree, applying the filter and context set to all levels

Returns:

filtered copy of the projectinfo

resolve

public void resolve(Path sourcePath)

setDataProvider

public void setDataProvider(CoverageDataProvider data)

Specified by:

setDataProvider in interface CoverageDataReceptor

getDataProvider

public CoverageDataProvider getDataProvider()

Specified by:

getDataProvider in interface CoverageDataReceptor

getDataIndex

public int getDataIndex()

Specified by:

getDataIndex in interface CoverageDataRange

Returns:

the starting index for this element (or its first child)

getDataLength

public int getDataLength()

Specified by:

getDataLength in interface CoverageDataRange

Returns:

the minimum length (from the data index) of coverage data to ensure enough data for this element and all children.

setDataLength

public void setDataLength(int length)

buildCaches

public void buildCaches()

isFragmented

public boolean isFragmented()

setFragmented

public void setFragmented(boolean fragmented)

getChildType

public String getChildType()

Specified by:

getChildType in interface HasMetricsNode

getNumChildren

public int getNumChildren()

Specified by:

getNumChildren in interface HasMetricsNode

getChild

public HasMetricsNode getChild(int i)

Specified by:

getChild in interface HasMetricsNode

getIndexOfChild

public int getIndexOfChild(HasMetricsNode child)

Specified by:

getIndexOfChild in interface HasMetricsNode

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface HasMetricsNode

setComparator

public void setComparator(Comparator cmp)

Specified by:

setComparator in interface HasMetricsNode

setVersion

public void setVersion(long version)

Overrides:

setVersion in class BaseProjectInfo

getMetrics

public BlockMetrics getMetrics()

Specified by:

getMetrics in interface HasMetrics

Overrides:

getMetrics in class BaseProjectInfo

getRawMetrics

public BlockMetrics getRawMetrics()

Specified by:

getRawMetrics in interface HasMetrics

Overrides:

getRawMetrics in class BaseProjectInfo

hasTestResults

public boolean hasTestResults()

setHasTestResults

public void setHasTestResults(boolean hasTestResults)

findPackageFragment

public PackageFragment findPackageFragment(String packageName)

invalidateCaches

public void invalidateCaches()

Specified by:

invalidateCaches in interface CachingInfo

Overrides:

invalidateCaches in class BaseProjectInfo

findPackage

public PackageInfo findPackage(String name)

Description copied from interface: HasPackages

Searches for a package with given name

Specified by:

findPackage in interface HasPackages

Overrides:

findPackage in class BaseProjectInfo

Parameters:

name - fully qualified package name

Returns:

PackageInfo package found or null