net.refractions.udig.issues
Class FixableIssue

java.lang.Object
  extended by net.refractions.udig.issues.AbstractIssue
      extended by net.refractions.udig.issues.AbstractFixableIssue
          extended by net.refractions.udig.issues.FixableIssue
All Implemented Interfaces:
IIssue

public class FixableIssue
extends AbstractFixableIssue


Field Summary
static java.lang.String ID
           
static java.lang.String KEY_PROBLEMOBJECT
           
 
Fields inherited from class net.refractions.udig.issues.AbstractFixableIssue
ATT_CLASS, ATT_ID, ATT_KEY, ATT_REQKEY, ATT_TARGET, KEY_FIXERMEMENTO, XPID_ISSUEFIXER
 
Constructor Summary
FixableIssue()
           
 
Method Summary
 java.lang.String getExtensionID()
          Returns the id of the extension definition for this type of Issue.
 java.lang.String getProblemObject()
          Returns A one or two word name for the object that has the issue.
 void init(IMemento memento, IMemento viewMemento, java.lang.String issueId, java.lang.String groupId, ReferencedEnvelope bounds)
          Called by framework to initialize the Issue.
 void save(IMemento memento)
          Subclasses should override and call super.save().
 void setProblemObject(java.lang.String problemObject)
           
 
Methods inherited from class net.refractions.udig.issues.AbstractFixableIssue
findIssueFixer, fixIssue, getFixerMemento, setFixerMemento
 
Methods inherited from class net.refractions.udig.issues.AbstractIssue
addIssueListener, getBounds, getDescription, getEditorID, getEditorInput, getGroupId, getId, getPerspectiveID, getPriority, getProperty, getPropertyNames, getResolution, getViewMemento, getViewPartId, notifyListeners, notifyPropertyListeners, removeIssueListener, setBounds, setDescription, setGroupId, setId, setPriority, setProperty, setResolution, setViewMemento, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final java.lang.String ID
See Also:
Constant Field Values

KEY_PROBLEMOBJECT

public static final java.lang.String KEY_PROBLEMOBJECT
See Also:
Constant Field Values
Constructor Detail

FixableIssue

public FixableIssue()
Method Detail

getExtensionID

public java.lang.String getExtensionID()
Description copied from interface: IIssue
Returns the id of the extension definition for this type of Issue. This is required so the framework can load the correct issue class during issue loading. If the class is can not be loaded then a Placeholder issue will be created instead which will notify the user that a plugin is required to manage the issue.

The extension id is formed by the namespace of the plugin combined with the name of the extension element.

For example: The FeatureIssue's extension id would be: net.refractions.udig.issues.featureIssue because the issue implementation is in the Issues plugin (which the id net.refractions.udig.issues) and the extension name is featureIssue. The two are combined to form the id of the extension


getProblemObject

public java.lang.String getProblemObject()
Description copied from interface: IIssue
Returns A one or two word name for the object that has the issue. This should be translateable and understandable by a human.


setProblemObject

public void setProblemObject(java.lang.String problemObject)

init

public void init(IMemento memento,
                 IMemento viewMemento,
                 java.lang.String issueId,
                 java.lang.String groupId,
                 ReferencedEnvelope bounds)
Description copied from interface: IIssue
Called by framework to initialize the Issue.

Specified by:
init in interface IIssue
Overrides:
init in class AbstractFixableIssue
Parameters:
memento - The saved state of a Issue. May be null.
viewMemento - the memento for initializing the view, may be null
issueId - the id the issue is assigned. IIssue.getId() must return the same id.
groupId - the group id of the issue.
bounds - the bounds of the issue.

save

public void save(IMemento memento)
Description copied from class: AbstractFixableIssue
Subclasses should override and call super.save().

Specified by:
save in interface IIssue
Overrides:
save in class AbstractFixableIssue
Parameters:
memento - the memento to populate with state data.