ca.sqlpower.architect.profile
Interface TableProfileCreator

All Known Implementing Classes:

AbstractTableProfileCreator, LocalReservoirProfileCreator, RemoteDatabaseProfileCreator

public interface TableProfileCreator

Service Provider Interface for creating profile results related to a particular database table. Different implementations can use different strategies that perform better under certain circumstances, sacrifice accuracy for performance, and so on.

Method Summary

boolean

doProfile(TableProfileResult tpr) Populates the given TableProfileResult (which must not be populated already) and all of its ColumnProfileResult children.

Method Detail

doProfile

boolean doProfile(TableProfileResult tpr)

Populates the given TableProfileResult (which must not be populated already) and all of its ColumnProfileResult children.

This may be a long-running operation. Its progress can be monitored and canceled via the TableProfileResult itself, which is Monitorable.

Parameters:

tpr - The unpopulated profile result to populate.

Returns:

true if the profiling of the table and its columns has completed normally; false if the profiling operation was canceled before it had a chance to complete.

Throws:

java.lang.RuntimeException - If the profiling fails for some reason other than a cancel request, an appropriate exception will be thrown.