com.lf.digester.wizard.sync

Class SyncWizard

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.lf.commons.wizard.WizardDialog

com.lf.digester.wizard.sync.SyncWizard

All Implemented Interfaces:

com.lf.commons.model.ConfigurableUnit, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class SyncWizard
extends com.lf.commons.wizard.WizardDialog

Wizard dialog to specify a source/target mapping to synchronize files/directories.

The wizard is a simple user interface with few pages to setup a standard sync process with a few steps. With the first pages the user specifies the source and target files and/or directories to be synchronized (data flow). On the next page the generate template may be chosen, the few options are extracted from the template. Some required options are presented here as well (e.g. if sub-directories should be processed). On the final page, the user specified the digest algorithms and/or the PGP signature keys to use. Remember, that signatures are compared byte for byte which could be problematic, since signatures are never created identically even for the same PGP key! Message digests are the best mechanism to synchronize files/folders. The Digester XML format should be preferred to benefit from the available extra data portions included here like the file size, timestamp etc.

Since:

1.6

Version:

$Revision: 1.13 $, $Date: 2015/01/08 09:03:42 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected com.lf.commons.lang.OrderedHashtable<java.lang.String,com.lf.commons.config.Configuration>	cacheTemplates Remembers the template configurations by their unique IDs.
protected java.lang.String	currentTemplate Remembers the active template.
protected GenerateOptionsWindow	generateWindow The generate docking window (template).
protected GeneratePage	pageGenerate The page holding the generate options.
protected OptionsPage	pageOptions The algorithms and PGP key page.
protected com.lf.commons.wizard.page.ComboChooserPage	pageSources The source chooser page.
protected com.lf.commons.wizard.page.ComboChooserPage	pageTargets The target chooser page.
protected com.lf.commons.config.Configuration	syncMapping The sync options.
protected SyncWindow	syncWindow The sync docking window (mapping).

Fields inherited from class com.lf.commons.wizard.WizardDialog

BUTTON_BACK, BUTTON_CANCEL, BUTTON_FINISH, BUTTON_NEXT, buttonBack_I18N, buttonCancel_I18N, buttonFinish_I18N, buttonHelp, buttonNext_I18N, clickedButton, exitButton, listeners, mode, MODE_DYNAMIC, MODE_STATIC, resizeListener, sequence, stack, startingPage, statusBar

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
SyncWizard() Constructor method for i18n purposes only.
SyncWizard(java.awt.Frame owner) Constructor for the GUI component.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	changeTemplate() Convenience to change the current template.
void	configureUnit(java.lang.String id, com.lf.commons.config.Configuration config) Restores values from persistent data stores.
protected void	finalize() Clean-up method to help the gc.
com.lf.commons.config.Configuration	getConfiguration() Assembles the page configurations so that the generation can be started based on settings.
void	reset() Resets the wizard pages for the next time this dialog is used.
void	storeUnit(java.lang.String id, com.lf.commons.config.Configuration config) Stores the current configuration values persistently.
void	unitRegistered(com.lf.commons.model.ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitUnregistered(com.lf.commons.model.ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.
protected void	updateTemplate(java.lang.String id) Convenience to store the current settings into the template.

Methods inherited from class com.lf.commons.wizard.WizardDialog

actionPerformed, addWizardPageListener, allowConfirmOnKeyStroke, allowEscapeOnKeyStroke, clickButton, execute, getButtonBack, getButtonCancel, getButtonFinish, getButtonNext, getClickedButton, getCurrentPage, getExitButton, getPreviousPage, getPreviousPages, getStatusBar, isButtonEnabled, removeWizardPageListener, setButtonEnabled, setDividerLocation, setEnabledBack, setEnabledCancel, setEnabledFinish, setEnabledNext, setHelpID, setOverviewText, setStartingPage, setVisible, showPage, updateOverview, updatePageIcon

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

pageSources

protected com.lf.commons.wizard.page.ComboChooserPage pageSources

The source chooser page.

pageTargets

protected com.lf.commons.wizard.page.ComboChooserPage pageTargets

The target chooser page.

pageGenerate

protected GeneratePage pageGenerate

The page holding the generate options.

pageOptions

protected OptionsPage pageOptions

The algorithms and PGP key page.

generateWindow

protected GenerateOptionsWindow generateWindow

The generate docking window (template).

currentTemplate

protected java.lang.String currentTemplate

Remembers the active template.

syncWindow

protected SyncWindow syncWindow

The sync docking window (mapping).

syncMapping

protected com.lf.commons.config.Configuration syncMapping

The sync options.

cacheTemplates

protected com.lf.commons.lang.OrderedHashtable<java.lang.String,com.lf.commons.config.Configuration> cacheTemplates

Remembers the template configurations by their unique IDs.

Constructor Detail

SyncWizard

public SyncWizard()
           throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

SyncWizard

public SyncWizard(java.awt.Frame owner)

Constructor for the GUI component.

Parameters:

owner - The owner frame

Throws:

java.lang.IllegalArgumentException - If a parameter is missing

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class com.lf.commons.wizard.WizardDialog

Throws:

java.lang.Throwable - Error indication

Since:

1.6

getConfiguration

public com.lf.commons.config.Configuration getConfiguration()

Assembles the page configurations so that the generation can be started based on settings.

Returns:

The configuration, null if wizard has not been finished or error case

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 com.lf.commons.config.Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface com.lf.commons.model.ConfigurableUnit

Overrides:

configureUnit in class com.lf.commons.wizard.WizardDialog

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             com.lf.commons.config.Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface com.lf.commons.model.ConfigurableUnit

Overrides:

storeUnit in class com.lf.commons.wizard.WizardDialog

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

unitRegistered

public void unitRegistered(com.lf.commons.model.ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface com.lf.commons.model.ConfigurableUnit

Overrides:

unitRegistered in class com.lf.commons.wizard.WizardDialog

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(com.lf.commons.model.ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface com.lf.commons.model.ConfigurableUnit

Overrides:

unitUnregistered in class com.lf.commons.wizard.WizardDialog

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

reset

public void reset()

Resets the wizard pages for the next time this dialog is used.

Since:

1.6

updateTemplate

protected void updateTemplate(java.lang.String id)

Convenience to store the current settings into the template.

Parameters:

id - The template ID

Since:

1.6

changeTemplate

protected void changeTemplate()

Convenience to change the current template.

Since:

1.6