org.argouml.application.api
Interface PluggableImport

All Superinterfaces:
ArgoModule, Pluggable
All Known Implementing Classes:
FileImportSupport

public interface PluggableImport
extends Pluggable

An interface which identifies an ArgoUML plug-in to the Import. Plug-ins are replacements or additions to standard Argo classes.

Since:
0.13.4

Field Summary
 
Fields inherited from interface org.argouml.application.api.Pluggable
PLUGIN_PREFIX, PLUGIN_TITLE, PLUGIN_VENDOR
 
Fields inherited from interface org.argouml.application.api.ArgoModule
cat, MODULEFILENAME, MODULEFILENAME_ALTERNATE
 
Method Summary
 javax.swing.JComponent getChooser(Import _import)
          Create chooser for objects we are to import.
 javax.swing.JComponent getConfigPanel()
          Provide pannel added to JTabbedPane after general panel.
 ClassdiagramLayouter getLayout(UMLDiagram diagram)
          Provide layout for modified or created class diagram.
 java.util.Vector getList(Import _import)
          This method returns a Vector with objects to import.
 boolean isParseable(java.lang.Object f)
          Tells if the object is parseable or not.
 void parseFile(Project p, java.lang.Object o, DiagramInterface diagram, Import _import)
          One parseable object from the list will be parsed by this method.
 
Methods inherited from interface org.argouml.application.api.Pluggable
inContext
 
Methods inherited from interface org.argouml.application.api.ArgoModule
getModuleAuthor, getModuleDescription, getModuleKey, getModuleName, getModulePopUpActions, getModuleVersion, initializeModule, isModuleEnabled, setModuleEnabled, shutdownModule
 

Method Detail

getChooser

public javax.swing.JComponent getChooser(Import _import)
Create chooser for objects we are to import. Chooser must have a button for object selection and optionally a button for cancel action. To close dialog window use _import.disposeDialog().

Parameters:
_import - - current import session
Returns:
the panel to show in import dialog

getConfigPanel

public javax.swing.JComponent getConfigPanel()
Provide pannel added to JTabbedPane after general panel.

Returns:
the panel with configuration info for plugin or null if no parameters are needed.

getList

public java.util.Vector getList(Import _import)
This method returns a Vector with objects to import. These objects are selected with chooser and may be rearranged in arbitrary order.

Parameters:
_import - - current import session
Returns:
vector of objects, selected by chooser

isParseable

public boolean isParseable(java.lang.Object f)
Tells if the object is parseable or not.

Parameters:
f - object to be tested.
Returns:
true if parseable, false if not.

parseFile

public void parseFile(Project p,
                      java.lang.Object o,
                      DiagramInterface diagram,
                      Import _import)
               throws java.lang.Exception
One parseable object from the list will be parsed by this method. Objects will be parsed in order defined by getList().

Parameters:
p - - the current project
o - - object to be parsed
diagram - - current class diagram when Import was invoked
_import - - current import session. Use this object to get common settings.
java.lang.Exception

getLayout

public ClassdiagramLayouter getLayout(UMLDiagram diagram)
Provide layout for modified or created class diagram.



ArgoUML © 1996-2003 (20030919)ArgoUML Project HomeArgoUML Cookbook