FileImportSupport (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.uml.reveng
Class FileImportSupport

java.lang.Object
  org.argouml.uml.reveng.FileImportSupport

All Implemented Interfaces:: ArgoModule, Pluggable, PluggableImport

Direct Known Subclasses:: JavaImport

public abstract class FileImportSupport
extends Object
implements PluggableImport

This is the base class for import from files. It provides JFileChooser for file selection and other methods common to file import. It assumes that similar classes will be written for other input sources.

Version:: $Revision: 1.14 $

Nested Class Summary
`private class`	`FileImportSupport.ImportFileChooser`

Field Summary
`private JRadioButton`	`attribute`
`private JPanel`	`configPanel`
`private JRadioButton`	`datatype`
`private static String`	`SEPARATOR`
`private Object`	`theFile` Object(s) selected in chooser.

Fields inherited from interface org.argouml.application.api.Pluggable

PLUGIN_PREFIX, PLUGIN_TITLE, PLUGIN_VENDOR

Fields inherited from interface org.argouml.application.api.ArgoModule

MODULEFILENAME, MODULEFILENAME_ALTERNATE

Constructor Summary
`FileImportSupport()`

Method Summary
`protected JRadioButton`	`getAttribute()`
`JComponent`	`getChooser(Import imp)` Create chooser for objects we are to import.
`JComponent`	`getConfigPanel()` Get the panel that lets the user set reverse engineering parameters.
`protected JRadioButton`	`getDatatype()`
`ClassdiagramLayouter`	`getLayout(UMLDiagram diagram)` Provide layout for modified class diagram.
`Vector`	`getList(Import theImport)` This method returns a Vector with objects to import.
`String`	`getModuleAuthor()` The module author.
`Vector`	`getModulePopUpActions(Vector popUpActions, Object context)` Calls all modules to let them add to a popup menu.
`String`	`getModuleVersion()` The module version.
`abstract SuffixFilter[]`	`getSuffixFilters()` Provides an array of suffixe filters for the module.
`boolean`	`inContext(Object[] context)` A function which allows a plug-in to decide if it is available under a specific context.
`boolean`	`initializeModule()` Method called when Argo is loading a module.
`boolean`	`isModuleEnabled()` Allows determination if a module is enabled or disabled.
`boolean`	`isParseable(Object f)` Tells if the file is parseable or not.
`void`	`parseFile(Project p, Object o, DiagramInterface diagram, Import theImport)` This method parses 1 file.
`void`	`setModuleEnabled(boolean tf)` Called to enable or disable a module programmatically.
`boolean`	`shutdownModule()` Method called when Argo is unloading a module.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.argouml.application.api.ArgoModule

getModuleDescription, getModuleKey, getModuleName

Field Detail

configPanel

private JPanel configPanel

attribute

private JRadioButton attribute

datatype

private JRadioButton datatype

SEPARATOR

private static final String SEPARATOR

See Also:: Constant Field Values

theFile

private Object theFile

Object(s) selected in chooser.

Constructor Detail

FileImportSupport

public FileImportSupport()

Method Detail

getConfigPanel

public JComponent getConfigPanel()

Get the panel that lets the user set reverse engineering parameters.

Specified by:: getConfigPanel in interface PluggableImport

Returns:: the panel with configuration info for plugin or null if no parameters are needed.
See Also:: PluggableImport.getConfigPanel()

parseFile

public void parseFile(Project p,
                      Object o,
                      DiagramInterface diagram,
                      Import theImport)
               throws Exception

This method parses 1 file. Default implementation does nothing.

Specified by:: parseFile in interface PluggableImport

Parameters:: p - the project; o - the object; diagram - the diagram interface; theImport - the import
Throws:: Exception - Parser exception.
See Also:: PluggableImport.parseFile( org.argouml.kernel.Project, java.lang.Object, org.argouml.uml.reveng.DiagramInterface, org.argouml.uml.reveng.Import)

getChooser

public JComponent getChooser(Import imp)

Create chooser for objects we are to import. Default implemented chooser is JFileChooser.

Specified by:: getChooser in interface PluggableImport

Parameters:: imp - The current import session.
Returns:: The panel to show in import dialog.
See Also:: PluggableImport.getChooser(org.argouml.uml.reveng.Import)

getList

public Vector getList(Import theImport)

This method returns a Vector with objects to import.

Processing each file in turn is equivalent to a breadth first search through the directory structure.

Specified by:: getList in interface PluggableImport

Parameters:: theImport - object called by this method.
Returns:: the list
See Also:: PluggableImport.getList(org.argouml.uml.reveng.Import)

isParseable

public boolean isParseable(Object f)

Tells if the file is parseable or not. Must match with files that are actually parseable.

Specified by:: isParseable in interface PluggableImport

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

getLayout

public ClassdiagramLayouter getLayout(UMLDiagram diagram)

Provide layout for modified class diagram.

Specified by:: getLayout in interface PluggableImport

Parameters:: diagram - to layout.
Returns:: the layouter.
See Also:: PluggableImport.getLayout(org.argouml.uml.diagram.ui.UMLDiagram)

inContext

public boolean inContext(Object[] context)

Description copied from interface: Pluggable

A function which allows a plug-in to decide if it is available under a specific context. One example of a plugin with multiple criteria is the PluggableMenu. PluggableMenu requires the first context to be a JMenuItem which wants the PluggableMenu attached to as the context, so that it can determine that it would attach to a menu. The second context is an internal (non-localized) description of the menu such as "File" or "View" so that the plugin can further decide.

Specified by:: inContext in interface Pluggable

Parameters:: context - An identification of the context. The interpretation of criteria is specific to the plug-in type, but must be consistent across that type. The plug-in must want to be exposed to all contexts.
Returns:: True if the plug-in wants to make itself available for this context, otherwise false.
See Also:: Pluggable.inContext(java.lang.Object[])