org.bibalex.daf.managers.checkin
Class RetrievalProgressDialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by org.bibalex.daf.managers.checkin.RetrievalProgressDialog
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.Observer, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class RetrievalProgressDialog
extends javax.swing.JDialog
implements java.util.Observer

This dialog allows the display of the retrieval progress. It does not contain any Progress Bar because the progress is not yet defined (No files to count, and no estimate about the expected time).

Author:
Fadi.Edward
See Also:
Serialized Form

Nested Class Summary
private  class RetrievalProgressDialog.RetrievalStarter
          Starts any Retrieval Operation.
 
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
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
private  javax.swing.JLabel currentActionLabel
           
private  RetrievalProgressDialog currentRetrievalProgressDialog
           
private  javax.swing.JButton doneButton
           
private  javax.swing.JPanel jContentPane
           
private  javax.swing.JPanel jMainPanel
           
private  javax.swing.JScrollPane progressHistoryScrollPane
           
private  javax.swing.JTextArea progressHistoryTextArea
           
private  boolean result
           
private static long serialVersionUID
           
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
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
RetrievalProgressDialog()
          Constructor.
 
Method Summary
 void appendMessage(java.lang.String message)
          Adds this message to the History and displays the message as Current State
private  javax.swing.JButton getDoneButton()
          This method initializes DoneButton
private  javax.swing.JPanel getJContentPane()
          This method initializes jContentPane
private  javax.swing.JPanel getJMainPanel()
          This method initializes jMainPanel
private  javax.swing.JScrollPane getProgressHistoryScrollPane()
           
private  javax.swing.JTextArea getProgressHistoryTextArea()
          This method initializes ProgressHistoryTextArea
 boolean getResult()
          Returns the Dialog result
private  void initialize()
          This method initializes this Progress Dialog.
 void retrieveJob(IRetrievalPlugin retrievalPlugin, Job job, int version, java.lang.String mediaBarcode, int transactionLogID, boolean removeExtraFiles)
          Starts the retrieval operation for the plugin
 void setDone()
          Enables the done Button, as an indication that the retrieval is completed.
 void update(java.util.Observable o, java.lang.Object arg)
          This method updates the UI upon the incoming notification from the Observer.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

jContentPane

private javax.swing.JPanel jContentPane

jMainPanel

private javax.swing.JPanel jMainPanel

progressHistoryTextArea

private javax.swing.JTextArea progressHistoryTextArea

doneButton

private javax.swing.JButton doneButton

currentActionLabel

private javax.swing.JLabel currentActionLabel

result

private boolean result

currentRetrievalProgressDialog

private RetrievalProgressDialog currentRetrievalProgressDialog

progressHistoryScrollPane

private javax.swing.JScrollPane progressHistoryScrollPane
Constructor Detail

RetrievalProgressDialog

public RetrievalProgressDialog()
Constructor. Constructs this dialog as Modal, and the owner is the MainControllerGUI frame.

Method Detail

initialize

private void initialize()
This method initializes this Progress Dialog.


getJContentPane

private javax.swing.JPanel getJContentPane()
This method initializes jContentPane

Returns:
javax.swing.JPanel

getJMainPanel

private javax.swing.JPanel getJMainPanel()
This method initializes jMainPanel

Returns:
javax.swing.JPanel

getProgressHistoryScrollPane

private javax.swing.JScrollPane getProgressHistoryScrollPane()

getProgressHistoryTextArea

private javax.swing.JTextArea getProgressHistoryTextArea()
This method initializes ProgressHistoryTextArea

Returns:
javax.swing.JTextArea

getDoneButton

private javax.swing.JButton getDoneButton()
This method initializes DoneButton

Returns:
javax.swing.JButton

appendMessage

public void appendMessage(java.lang.String message)
Adds this message to the History and displays the message as Current State

Parameters:
message - The message to be set as Current State, and to be added to the history.

setDone

public void setDone()
Enables the done Button, as an indication that the retrieval is completed.


retrieveJob

public void retrieveJob(IRetrievalPlugin retrievalPlugin,
                        Job job,
                        int version,
                        java.lang.String mediaBarcode,
                        int transactionLogID,
                        boolean removeExtraFiles)
Starts the retrieval operation for the plugin

Parameters:
retrievalPlugin - The retrieval plugin used for the current retrieval operation
job - The job to be retrieved
version - The version of the job to be retrieved
mediaBarcode - The media barcode of the media to retrieve the job from
transactionLogID - The transactionLogID for the job, used to get the status definition of the job
removeExtraFiles - Indicates wether to remove extra files (any thing that is not defined if the backup Def) or Not.

getResult

public boolean getResult()
Returns the Dialog result

Returns:
boolean with the dialog result.

update

public void update(java.util.Observable o,
                   java.lang.Object arg)
This method updates the UI upon the incoming notification from the Observer.

Specified by:
update in interface java.util.Observer
See Also:
Observer.update(Observable, Object)