ca.sqlpower.architect.ddl
Interface DDLWarning

All Known Implementing Classes:

AbstractDDLWarning, InvalidNameDDLWarning, InvalidSeqNameDDLWarning, RelationshipColumnsTypesMismatchDDLWarning, SetDefaultOnColumnWithNoDefaultWarning, SetNullOnNonNullableColumnWarning, TypeMapDDLWarning, UnsupportedFeatureDDLWarning

public interface DDLWarning

A DDLWarning object encapsulates the details of a single warning message issued by a DDL generator.

Method Summary

java.util.List<? extends SQLObject>	getInvolvedObjects() The subject(s) of this warning.
java.lang.String	getMessage() Get the message associated with this warning, e.g., a string like "Primary Key Name is already in use"
java.lang.String	getQuickFixMessage() If isQuickFixable(), then this gives the message about what will be done.
java.lang.String	getQuickFixPropertyName() Returns the name of the Beans property of the involved object(s) that can be modified to fix the problem.
boolean	isFixed() Return true if the user has repaired or quickfixed the problem
boolean	isQuickFixable() Tell whether the user can "quick fix" this problem
boolean	quickFix() If isQuickFixable(), then this applies the quick fix
void	setFixed(boolean fixed)

Method Detail

getMessage

java.lang.String getMessage()

Get the message associated with this warning, e.g., a string like "Primary Key Name is already in use"

getInvolvedObjects

java.util.List<? extends SQLObject> getInvolvedObjects()

The subject(s) of this warning. For instance, if there is a duplicate table names, the SQLTable objects with the duplicate names will be the "involved objects".

isFixed

boolean isFixed()

Return true if the user has repaired or quickfixed the problem

setFixed

void setFixed(boolean fixed)

isQuickFixable

boolean isQuickFixable()

Tell whether the user can "quick fix" this problem

getQuickFixMessage

java.lang.String getQuickFixMessage()

If isQuickFixable(), then this gives the message about what will be done.

quickFix

boolean quickFix()

If isQuickFixable(), then this applies the quick fix

getQuickFixPropertyName

java.lang.String getQuickFixPropertyName()

Returns the name of the Beans property of the involved object(s) that can be modified to fix the problem. For example, if the warning is about a duplicate or illegal name, this method would return "name". If the warning is about an illegal type, this method would return "type". If the warning does not pertain to a problem that can be fixed by fiddling with a particular property value, this method will return null.