ExportArchiveAction

java.lang.Object
- javax.swing.AbstractAction
- - ptolemy.vergil.toolbox.FigureAction
  - - org.kepler.gui.kar.ExportArchiveAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

Direct Known Subclasses:

ExportActorArchiveAction, ExportRunsArchiveAction
```
public class ExportArchiveAction
extends FigureAction
```
This action exports a workflow as a kar file. Subclasses of this class should be used for saving any type of KAR file. To make a subclass you will want to override the initialize method and the handle action method. See ExportActorArchiveAction for an example subclass.

Author:

Aaron Schultz, Christopher Brooks

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class ptolemy.vergil.toolbox.FigureAction
  FigureAction.SourceType

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`_defaultFileName`
`protected java.lang.String`	`_karType` A string that represents to the user the type of KAR that is being exported.
`protected LocalRepositoryManager`	`_localRepositoryManager` Convenience reference to the LocalRepositoryManager.
`protected boolean`	`_mapKARToCurrentFrame`
`protected boolean`	`_nonInteractiveSave`
`protected java.lang.String`	`_overrideModuleDependencies`
`protected TableauFrame`	`_parent`
`protected java.io.File`	`_saveFile`
`protected SaveKAR`	`_savekar` The SaveKAR object is a GUI free helper class for saving KARs.
`protected boolean`	`_saveSucceeded`
`protected boolean`	`_singleItemKAR` The purpose of KARs are for grouping things together.
`protected boolean`	`_upload`
`protected boolean`	`refreshFrameAfterSave`
`boolean`	`useTempFile` prevent the file chooser from displaying and just use a temp file

Fields inherited from class ptolemy.vergil.toolbox.FigureAction
CANVAS_TYPE, CONTEXTMENU_TYPE, HOTKEY_TYPE, MENUBAR_TYPE, PASTE_OFFSET, TOOLBAR_TYPE

Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled

Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors
Constructor and Description

ExportArchiveAction(TableauFrame parent)
Constructor

Constructors
Constructor and Description
`ExportArchiveAction(TableauFrame parent)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(java.awt.event.ActionEvent e)` Invoked when an action occurs.
`protected boolean`	`checkSingleObject(NamedObj entity, boolean checkIfSemenaticallyAnnotated)` Check a single NamedObj for LSID, name, and SemanticType.
`boolean`	`doUpload()`
`java.lang.String`	`getDefaultFileName()` Get default KAR save filename.
`SaveKAR`	`getSaveKAR()`
`protected boolean`	`handleAction(java.awt.event.ActionEvent e)` This method will set up the SaveKAR object in the case of saving a workflow.
`protected void`	`initialize()` The initialize method is called at the end of the public constructor.
`boolean`	`isRefreshFrameAfterSave()`
`boolean`	`isSingleItemKAR()`
`boolean`	`mapKARToCurrentFrame()`
`protected void`	`overrideModuleDependencies(java.lang.String moduleDependencies)`
`boolean`	`saveSucceeded()`
`void`	`setDefaultFileName(java.lang.String name)` Set default KAR save filename.
`void`	`setMapKARToCurrentFrame(boolean mapKARToCurrentFrame)` Set true when this KAR should not be mapped to this JFrame.
`void`	`setRefreshFrameAfterSave(boolean refreshFrameAfterSave)` Allow for toggling the close/open of the main frame after saving.
`void`	`setSaveFile(java.io.File saveFile)` Call this before actionPerformed to do a non-interactive Save, not a Save As...
`void`	`setSingleItemKAR(boolean singleItemKAR)`
`void`	`setUpload(boolean upload)` Set false if you don't want user prompted to upload after save if they have a remote repository selected.

Methods inherited from class ptolemy.vergil.toolbox.FigureAction
getFigure, getFrame, getSourceType, getTarget, getX, getY, offsetFigure

Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _parent
```
protected TableauFrame _parent
```
  - _saveSucceeded
```
protected boolean _saveSucceeded
```
  - _savekar
```
protected SaveKAR _savekar
```
    The SaveKAR object is a GUI free helper class for saving KARs.
  - _karType
```
protected java.lang.String _karType
```
    A string that represents to the user the type of KAR that is being exported. This string may appear in dialog messages to allow different callers to better identify to the user what the contents of this KAR file are. This should be the first thing set in the handleType method of any subclasses of this class but is not required.
  - refreshFrameAfterSave
```
protected boolean refreshFrameAfterSave
```
  - _mapKARToCurrentFrame
```
protected boolean _mapKARToCurrentFrame
```
  - _singleItemKAR
```
protected boolean _singleItemKAR
```
    The purpose of KARs are for grouping things together. Sometimes though we have only one thing in a KAR which changes some things. This is a bit confusing here because this refers to a single item being saved from the user perspective. Just because we're saving a single item at this stage does not mean there will only be one file in the KAR. There may be other files associated with the single item that we're saving from this class. For example we may be saving a single workflow that has many files associated with it.
  - _defaultFileName
```
protected java.lang.String _defaultFileName
```
  - _overrideModuleDependencies
```
protected java.lang.String _overrideModuleDependencies
```
  - _upload
```
protected boolean _upload
```
  - _saveFile
```
protected java.io.File _saveFile
```
  - _nonInteractiveSave
```
protected boolean _nonInteractiveSave
```
  - _localRepositoryManager
```
protected LocalRepositoryManager _localRepositoryManager
```
    Convenience reference to the LocalRepositoryManager.
  - useTempFile
```
public boolean useTempFile
```
    prevent the file chooser from displaying and just use a temp file
- Constructor Detail
  - ExportArchiveAction
```
public ExportArchiveAction(TableauFrame parent)
```
    Constructor
    
    Parameters:
    
    parent - the "frame" (derived from ptolemy.gui.Top) where the menu is being added.
- Method Detail
  - setSaveFile
```
public void setSaveFile(java.io.File saveFile)
```
    Call this before actionPerformed to do a non-interactive Save, not a Save As... and don't attempt upload.
    
    Parameters:
    
    saveFile -
  - isSingleItemKAR
```
public boolean isSingleItemKAR()
```
  - setSingleItemKAR
```
public void setSingleItemKAR(boolean singleItemKAR)
```
  - doUpload
```
public boolean doUpload()
```
    Returns:
    
    boolean controlling if upload should occur
  - setUpload
```
public void setUpload(boolean upload)
```
    Set false if you don't want user prompted to upload after save if they have a remote repository selected.
    
    Parameters:
    
    upload -
  - getSaveKAR
```
public SaveKAR getSaveKAR()
```
  - setDefaultFileName
```
public void setDefaultFileName(java.lang.String name)
```
    Set default KAR save filename.
    
    Parameters:
    
    name -
  - getDefaultFileName
```
public java.lang.String getDefaultFileName()
```
    Get default KAR save filename.
    
    Returns:
    
    _defaultFileName
  - isRefreshFrameAfterSave
```
public boolean isRefreshFrameAfterSave()
```
    Returns:
    
    the refreshFrameAfterSave
  - setRefreshFrameAfterSave
```
public void setRefreshFrameAfterSave(boolean refreshFrameAfterSave)
```
    Allow for toggling the close/open of the main frame after saving. This makes sense for workflows but not for other types of saves like actors.
    
    Parameters:
    
    refreshFrameAfterSave - the refreshFrameAfterSave to set
  - setMapKARToCurrentFrame
```
public void setMapKARToCurrentFrame(boolean mapKARToCurrentFrame)
```
    Set true when this KAR should not be mapped to this JFrame.
  - mapKARToCurrentFrame
```
public boolean mapKARToCurrentFrame()
```
  - initialize
```
protected void initialize()
```
    The initialize method is called at the end of the public constructor. This makes it easier to change the behavior of constructing a subclass.
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent e)
```
    Invoked when an action occurs.
    
    Specified by:
    
    actionPerformed in interface java.awt.event.ActionListener
    
    Overrides:
    
    actionPerformed in class FigureAction
    
    Parameters:
    
    e - ActionEvent
  - saveSucceeded
```
public boolean saveSucceeded()
```
    Returns:
    
    whether or not the file was saved to disk
  - handleAction
```
protected boolean handleAction(java.awt.event.ActionEvent e)
```
    This method will set up the SaveKAR object in the case of saving a workflow. To save other types of KARs a subclass that overrides this method can be used to add multiple workflows to the SaveKAR object and to identify other objects that should be added to the KAR through the appropriate KAREntryHandlers.
    
    Parameters:
    
    e -
    
    Returns:
    
    boolean true if the export should continue
  - overrideModuleDependencies
```
protected void overrideModuleDependencies(java.lang.String moduleDependencies)
```
  - checkSingleObject
```
protected boolean checkSingleObject(NamedObj entity,
                                    boolean checkIfSemenaticallyAnnotated)
```
    Check a single NamedObj for LSID, name, and SemanticType.
    
    Parameters:
    
    checkIfSemenaticallyAnnotated - If is true, and entity has no semantic annotations, user is warned, but not required, to add annotations.
    
    Returns:
    
    Returns true if the export should continue

Class ExportArchiveAction

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.vergil.toolbox.FigureAction

Field Summary

Fields inherited from class ptolemy.vergil.toolbox.FigureAction

Fields inherited from class javax.swing.AbstractAction

Fields inherited from interface javax.swing.Action

Constructor Summary

Method Summary

Methods inherited from class ptolemy.vergil.toolbox.FigureAction

Methods inherited from class javax.swing.AbstractAction

Methods inherited from class java.lang.Object

Field Detail

_parent

_saveSucceeded

_savekar

_karType

refreshFrameAfterSave

_mapKARToCurrentFrame

_singleItemKAR

_defaultFileName

_overrideModuleDependencies

_upload

_saveFile

_nonInteractiveSave

_localRepositoryManager

useTempFile

Constructor Detail

ExportArchiveAction

Method Detail

setSaveFile

isSingleItemKAR

setSingleItemKAR

doUpload

setUpload

getSaveKAR

setDefaultFileName

getDefaultFileName

isRefreshFrameAfterSave

setRefreshFrameAfterSave

setMapKARToCurrentFrame

mapKARToCurrentFrame

initialize

actionPerformed

saveSucceeded

handleAction

overrideModuleDependencies

checkSingleObject