ca.sqlpower.architect.profile
Interface ProfileResult<T extends SQLObject>

All Known Implementing Classes:

AbstractProfileResult, ColumnProfileResult, TableProfileResult

public interface ProfileResult<T extends SQLObject>

A ProfileResult is an interface for populating profile data about database objects (for example, tables and columns), and for monitoring the progress of the profiling operation, which can often take considerable time to calculate.

Method Summary

void	addProfileResultListener(ProfileResultListener listener) Add a ProfileResultListener that should be notified of changes in the status of this ProfileResult's progress during a profile operation
long	getCreateEndTime() Returns the date and time that this ProfileResult finished profiling the profiled object.
long	getCreateStartTime() Returns the date and time that this ProfileResult started profiling the profiled object.
java.lang.Exception	getException() Returns the Exception that occured during the profiling of the profiled object.
T	getProfiledObject() Returns the SQLObject that is profiled by this ProfileResult.
long	getTimeToCreate() Returns the time it took to create this ProfileResult in milliseconds.
void	removeProfileResultListener(ProfileResultListener listener) Remove a ProfileResultListener from this ProfileResult's collection of ProfileResultListeners

Method Detail

getProfiledObject

T getProfiledObject()

Returns the SQLObject that is profiled by this ProfileResult.

getCreateStartTime

long getCreateStartTime()

Returns the date and time that this ProfileResult started profiling the profiled object.

getTimeToCreate

long getTimeToCreate()

Returns the time it took to create this ProfileResult in milliseconds.

getCreateEndTime

long getCreateEndTime()

Returns the date and time that this ProfileResult finished profiling the profiled object.

getException

java.lang.Exception getException()

Returns the Exception that occured during the profiling of the profiled object. If this method returns null then the profiled object is not done populating yet or it has sucessfully populated without throwing an Exception.

addProfileResultListener

void addProfileResultListener(ProfileResultListener listener)

Add a ProfileResultListener that should be notified of changes in the status of this ProfileResult's progress during a profile operation

removeProfileResultListener

void removeProfileResultListener(ProfileResultListener listener)

Remove a ProfileResultListener from this ProfileResult's collection of ProfileResultListeners