ch.epfl.craft.magmap
Class MagMap

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Panel
              java.applet.Applet
                  javax.swing.JApplet
                      ch.epfl.craft.magmap.MagMap

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable

public class MagMap

extends javax.swing.JApplet

This is the main class that starts the MagMap application It also has the responsability to load resources for other classes. This code is hybrid in the sense that it can either initiliaze an applet or a standard java application.

Version:

1.0

Author:

Jerome Caffaro

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JApplet

javax.swing.JApplet.AccessibleJApplet

Nested classes inherited from class java.applet.Applet

java.applet.Applet.AccessibleApplet

Nested classes inherited from class java.awt.Panel

java.awt.Panel.AccessibleAWTPanel

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

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

Field Summary

static boolean

startedAsApplet

Fields inherited from class javax.swing.JApplet

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

MagMap()

Method Summary

void	destroy() Should clean code used by the applet version of MagMap.
static com.schema.CorpusType	getBlogs(java.lang.String path) Loads the blog corpus at path.
static java.net.URL	getHelp() Loads the html help file.
static javax.swing.ImageIcon	getImageIcon(java.lang.String resource) Loads an image from the resources folder and creates a new ImageIcon.
static java.lang.String	getLocalizedText(java.lang.String textToBeLocalized) Loads the localized version of a string from the localization bundle (resources/MagMap.properties).
static com.schema.MatrixType	getSimilarityMatrix(java.lang.String path) Loads the similarity matrix at path .
void	init() Should initialize code used by the applet version of MagMap.
static void	main(java.lang.String[] args) Main method
void	setJMenuBar(javax.swing.JMenuBar aMenuBar) Overrides the setJMenuBar() method of JApplet so that the menu bar will be placed on the frame when MagMap is launched as a jar or on the applet when lauched as applet.
void	start() Should start the code used by the applet MagMap.
void	stop() Should stop the code used by the applet version of MagMap.

Methods inherited from class javax.swing.JApplet

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, remove, setContentPane, setGlassPane, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.applet.Applet

getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus

Methods inherited from class java.awt.Panel

addNotify

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, 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, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

startedAsApplet

public static boolean startedAsApplet

Constructor Detail

MagMap

public MagMap()

Method Detail

getImageIcon

public static javax.swing.ImageIcon getImageIcon(java.lang.String resource)

Loads an image from the resources folder and creates a new ImageIcon.

Parameters:

resource - the name of the image to load

Returns:

an ImageIcon of the image file

getHelp

public static java.net.URL getHelp()

Loads the html help file. TODO: Should return a localized version

Returns:

the URL of the html help

getBlogs

public static com.schema.CorpusType getBlogs(java.lang.String path)

Loads the blog corpus at path. This methods will load the entire corpus of blogs from the xml file saved in the resources folder. This loader directly use the class automatically generated by XML Spy. See the XML Schema corpus.xsd describing the structure of the corpus in xml in the docs directory of the projet. If path is null, the default location is used

Returns:

the blog corpus

getSimilarityMatrix

public static com.schema.MatrixType getSimilarityMatrix(java.lang.String path)

Loads the similarity matrix at path . This methods will load the entire matrix, which contains the similarity between the topics and data (blogs, news. etc), from the xml file saved in the resources folder. This loader directly use the class automatically generated by XML Spy. See the XML Schema matrix.xsd describing the structure of the matrix in xml in the docs directory of the projet. If path is null, the default location is used

Returns:

the similarity matrix

getLocalizedText

public static java.lang.String getLocalizedText(java.lang.String textToBeLocalized)

Loads the localized version of a string from the localization bundle (resources/MagMap.properties). The current locale is used. It it does not exists, returns the text in English.

Parameters:

textToBeLocalized - the text that is to be retrieved in its localized version from the bundle

Returns:

a localized string

setJMenuBar

public void setJMenuBar(javax.swing.JMenuBar aMenuBar)

Overrides the setJMenuBar() method of JApplet so that the menu bar will be placed on the frame when MagMap is launched as a jar or on the applet when lauched as applet. This is important for Mac OS, as it places tries to place the JMenu at the top of the screen

Parameters:

aMenuBar - the menu to add to the MagMap

init

public void init()

Should initialize code used by the applet version of MagMap. This is however not used by the application

start

public void start()

Should start the code used by the applet MagMap. This is however not used by the application

stop

public void stop()

Should stop the code used by the applet version of MagMap. This is however not used by the application

destroy

public void destroy()

Should clean code used by the applet version of MagMap. This is however not used by the application

main

public static void main(java.lang.String[] args)

Main method

Parameters:

args - the arguments of the application.