java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
javax.swing.JFrame
org.htmlparser.parserapplications.filterbuilder.FilterBuilder
All Implemented Interfaces:
ClipboardOwner, DragGestureListener, DragSourceListener, DropTargetListener, ActionListener, MouseListener, MouseMotionListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

The main program for the FilterBuilder programming system.

ToDo:

  • thread the attribute fetching
  • CSS selector filter
  • table row filter
  • table column filter
  • trigger filter
  • undo
  • handle bad URLs
  • StringBean type secondary text output
  • context sensitive menus
See Also:
  • Field Details

    • mBasePoint

      protected Point mBasePoint
      The relative position of the mouse while dragging.
    • mSelection

      protected Vector mSelection
      Selected commands.
    • mMoved

      protected boolean mMoved
      If true selection moved.
    • mDropTarget

      protected DropTarget mDropTarget
      This component is a drop target.
    • mDragSource

      protected DragSource mDragSource
      Enables this component to be a Drag Source.
    • mCurrentComponent

      protected Component mCurrentComponent
      Kludge: Used by actionPerformed/filterAction to remember the filter menu item.
    • mMainPanel

      protected JPanel mMainPanel
      The main panel GUI component.
    • mMainScroller

      protected JScrollPane mMainScroller
      The main panel scrolling GUI component.
    • mURLField

      protected JTextField mURLField
      The URL input GUI component.
    • mOutput

      protected JDesktopPane mOutput
      The output panel GUI component.
  • Constructor Details

    • FilterBuilder

      public FilterBuilder()
      Create an FilterBuilder programming environment.
    • FilterBuilder

      public FilterBuilder(String title)
      Creates a new instance of an FilterBuilder environment with the given title.
      Parameters:
      title - the title for the new frame.
      See Also:
  • Method Details

    • makeMenuButton

      protected void makeMenuButton(String name, String description, String text, int mnemonic, KeyStroke key, JToolBar toolbar, JMenu menu)
      Makes menu and toolbar items for commands.
      Parameters:
      name - The name of the command.
      description - A description for the tooltip.
      text - The text for the menu.
      mnemonic - The navigation mnemonic.
      key - Accelerator key.
      toolbar - The toolbar to add the button to.
      menu - The menu to add the menu item to.
    • getURL

      protected URL getURL(String spec) throws MalformedURLException
      Get a url for the given resource specification.
      Parameters:
      spec - The name of the resource.
      Returns:
      The fully formed URL.
      Throws:
      MalformedURLException - In the case that the document base or name of the resource cannot be turned into a URL.
    • makeFilterButton

      public JButton makeFilterButton(String class_name)
      Creates a new button for the given class.
      Parameters:
      class_name - The name of the Filter class.
      Returns:
      A fully functional button with name, tool tip, icon and drag recognizer.
    • addFilter

      public void addFilter(JMenu menu, JToolBar toolbar, String class_name)
      Add a filter to the GUI. Adds the filter specified by class_name to the menu, toolbar and starts listening for actions.
      Parameters:
      menu - The menu to add the filter to.
      toolbar - The toolbar to add the filter to.
      class_name - The class name for the filter wrapper. From the wrapper, the NodeFilter, description and icon can be obtained.
    • insertFilters

      protected void insertFilters(Filter[] filters, Point point, SubFilterList list)
      Adds a set of filters to the main panel or a sublist. Sets up the GUI components as drop targets and mouse listeners, and performs a relayout to display them.
      Parameters:
      filters - The filter wrappers to add.
      point - The point at which to start adding (list == null).
      list - The list to add to (point not used), or null for the main panel.
    • setBasePoint

      protected void setBasePoint(Point point)
      Sets the position of the mouse in the component.
      Parameters:
      point - The point where the mouse position is.
    • getBasePoint

      protected Point getBasePoint()
      Gets the current base point of the mouse pointer. This value is used to offset the drag position to maintain the mouse position at the same relative position within the card while dragging.
      Returns:
      The current base point of the mouse pointer.
    • getEnclosing

      protected SubFilterList getEnclosing(Component component)
      Get the enclosing sub filter list if any.
      Parameters:
      component - The component that's supposedly enclosed.
      Returns:
      The enclosing component or null otherwise.
    • getEnclosed

      protected SubFilterList getEnclosed(Component component)
      Get the enclosed sub filter list if any.
      Parameters:
      component - The component that's supposedly enclosing the list.
      Returns:
      The enclosed component or null otherwise.
    • makeProgram

      protected void makeProgram(String name, StringBuffer out, FilterBean bean)
      Makes a program like:
       // Generated by FilterBuilder. http://htmlparser.org
       // [aced0005737200206f72672e68746d6c7061727365722e66696c746572732e416e6446696c74657224c30516b2b7b2120200015b000b6d5072656469636174657374001c5b4c6f72672f68746d6c7061727365722f4e6f646546696c7465723b78707572001c5b4c6f72672e68746d6c7061727365722e4e6f646546696c7465723b8f17479b1d5f7992020000787000000002737200246f72672e68746d6c7061727365722e66696c746572732e5461674e616d6546696c746572b28b2601a614890f0200014c00056d4e616d657400124c6a6176612f6c616e672f537472696e673b78707400044d455441737200296f72672e68746d6c7061727365722e66696c746572732e48617341747472696275746546696c74657296abdfb3b0714cda0200024c000a6d41747472696275746571007e00064c00066d56616c756571007e000678707400046e616d6570]
                                                                                                                                                               
       import org.htmlparser.*;
       import org.htmlparser.filters.*;
       import org.htmlparser.beans.*;
       import org.htmlparser.util.*;
                                                                                                                                                               
       public class Test
       {
           public static void main (String args[])
           {
               TagNameFilter filter0 = new TagNameFilter ();
               filter0.setName ("META");
               HasAttributeFilter filter1 = new HasAttributeFilter ();
               filter1.setAttributeName ("name");
               NodeFilter[] array0 = new NodeFilter[2];
               array0[0] = filter0;
               array0[1] = filter1;
               AndFilter filter2 = new AndFilter ();
               filter2.setPredicates (array0);
               NodeFilter[] array1 = new NodeFilter[1];
               array1[0] = filter2;
               FilterBean bean = new FilterBean ();
               bean.setFilters (array1);
               if (0 != args.length)
               {
                   bean.setURL (args[0]);
                   System.out.println (bean.getNodes ().toHtml ());
               }
               else
                   System.out.println ("Usage: java -classpath .:htmlparser.jar Test ");
           }
       }
       
      Parameters:
      name - The name of the class.
      out - The buffer to append to.
      bean - The bean to extract the filters from to make the program.
    • classFromFile

      protected String classFromFile(String file)
      Extracts a java class name from a file name. ToDo: make this package-smart somehow.
      Parameters:
      file - The name of the file.
      Returns:
      The name of the class.
    • save

      public void save(String name)
      Save the workspace contents to file.
      Parameters:
      name - The name of the file to save it under.
    • newAction

      protected void newAction()
      The action to take when "New" menu or button pressed.
    • openAction

      protected void openAction()
      The action to take when "Open" menu or button pressed.
    • saveAction

      protected void saveAction()
      The action to take when "Save" menu or button pressed.
    • saveasAction

      protected void saveasAction()
      The action to take when "Save As" menu or button pressed.
    • exitAction

      protected void exitAction()
      The action to take when "Exit" menu or button pressed.
    • cutAction

      protected void cutAction()
      The action to take when "Cut" menu or button pressed.
    • copyAction

      protected void copyAction()
      The action to take when "Copy" menu or button pressed.
    • pasteAction

      protected void pasteAction()
      The action to take when "Paste" menu or button pressed.
    • deleteAction

      protected void deleteAction()
      The action to take when "Delete" menu or button pressed.
    • filterAction

      protected void filterAction()
      The action to take when a filter menu or button pressed.
    • fetchAction

      protected void fetchAction()
      The action to take when "Fetch" menu pressed.
    • executeAction

      protected void executeAction()
      The action to take when "Execute" menu or button pressed.
    • instructionsAction

      protected void instructionsAction()
      The action to take when "Instructions" menu pressed.
    • filteringAction

      protected void filteringAction()
      The action to take when "Filtering" menu pressed.
    • tutorialAction

      protected void tutorialAction()
      The action to take when "Tutorial" menu pressed.
    • hintsAction

      protected void hintsAction()
      The action to take when "Hints" menu pressed.
    • aboutAction

      protected void aboutAction()
      The action to take when "About" menu or button pressed.
    • expandAction

      public void expandAction()
      The action to take when "Expand" menu chosen.
    • collapseAction

      public void collapseAction()
      The action to take when "Collapse" menu chosen.
    • expandAllAction

      public void expandAllAction()
      The action to take when "Expand All" menu chosen.
    • collapseAllAction

      public void collapseAllAction()
      The action to take when "Collapse" menu chosen.
    • setupMouseListeners

      public void setupMouseListeners(Filter[] filters)
      Set up mouse listeners. Sets this up to listen to each command in the list as a MouseListener. Recursively descends the tree adding to all contained elements also.
      Parameters:
      filters - The container with commands in it.
    • setupDropTargets

      public void setupDropTargets(Filter[] filters)
      Set up drop targets. Recursively descends the filter tree and sets up the filter lists as drop targets.
      Parameters:
      filters - The container with filters in it.
    • setExpanded

      public void setExpanded(Filter[] filters, boolean expanded, boolean recursive)
      Expand or collapse filters, possibly recursively.
      Parameters:
      filters - The list of filters to expand or collapse.
      expanded - If true the filters are expanded, otherwise they are collapsed.
      recursive - If true the filters are processed recursively.
    • getFilters

      public Filter[] getFilters()
      Retrieve the top level filters in the main window.
      Returns:
      The top level filters.
    • relayout

      public void relayout()
      Redo the layout.
    • open

      public void open(String name)
      Read a workspace from file. The current contents are erased.
      Parameters:
      name - The name of the file to open.
    • showContextMenu

      public void showContextMenu(MouseEvent event)
      Show a pop up context menu. Shows a context sensitive popup menu at the location of the mouse event.
      Parameters:
      event - The mouse event that initiates the popup.
    • addSelection

      protected void addSelection(Filter filter)
      Add a filter to the current selection set.
      Parameters:
      filter - The filter to add.
    • removeSelection

      protected void removeSelection(Filter filter)
      Remove a filter from the current selection set.
      Parameters:
      filter - The filter to remove.
    • selectSelection

      protected void selectSelection(boolean select)
      Select(highlight)/deselect the current selection set.
      Parameters:
      select - If true turn on highlighting, turn it off otherwise.
    • clearSelection

      protected void clearSelection()
      Clear (empty) the current selection set.
    • moveSelection

      protected void moveSelection(Point translation)
      Move the current selection set as a group.
      Parameters:
      translation - The displacement to move them all by.
    • selectionContains

      protected boolean selectionContains(Filter filter)
      Check if the current selection set contains the given filter.
      Parameters:
      filter - The filter to check.
      Returns:
      true if the filter is a member, false otherwise.
    • lastSelected

      protected Filter lastSelected()
      Return the last filter added to the selection set.
      Returns:
      The last filter added or null if the current selection set is empty.
    • getSelection

      protected Filter[] getSelection()
      Return the current selection set as an array.
      Returns:
      The array of selected filters.
    • serializeSelection

      public String serializeSelection()
      Serialize the current selection set.
      Returns:
      The serialized form of the set of filters.
    • deleteSelection

      public void deleteSelection()
      Delete the current selection set from the filters in the GUI.
    • isSingleSelection

      public boolean isSingleSelection()
      Check if there is more than one filter selected.
      Returns:
      true if only one filter is selected, false otherwise.
    • mouseClicked

      public void mouseClicked(MouseEvent event)
      Invoked when the mouse has been clicked on a component.
      Specified by:
      mouseClicked in interface MouseListener
      Parameters:
      event - The mouse clicked event.
    • mouseReleased

      public void mouseReleased(MouseEvent event)
      Invoked when a mouse button has been released on a component.
      Specified by:
      mouseReleased in interface MouseListener
      Parameters:
      event - The mouse released event.
    • mouseEntered

      public void mouseEntered(MouseEvent event)
      Invoked when the mouse enters a component.
      Specified by:
      mouseEntered in interface MouseListener
      Parameters:
      event - The mouse entered event.
    • mouseExited

      public void mouseExited(MouseEvent event)
      Invoked when the mouse exits a component.
      Specified by:
      mouseExited in interface MouseListener
      Parameters:
      event - The mouse exited event.
    • mousePressed

      public void mousePressed(MouseEvent event)
      Invoked when a mouse button has been pressed on a component.
      Specified by:
      mousePressed in interface MouseListener
      Parameters:
      event - The mouse pressed event.
    • mouseDragged

      public void mouseDragged(MouseEvent event)
      Mouse drag notification. Invoked when a mouse button is pressed on a component and then dragged. Mouse drag events will continue to be delivered to the component where the first originated until the mouse button is released (regardless of whether the mouse position is within the bounds of the component).
      Specified by:
      mouseDragged in interface MouseMotionListener
      Parameters:
      event - The mouse drag event.
    • mouseMoved

      public void mouseMoved(MouseEvent event)
      Mouse move notification. Invoked when the mouse button has been moved on a component (with no buttons no down).
      Specified by:
      mouseMoved in interface MouseMotionListener
      Parameters:
      event - The mouse moved event.
    • windowOpened

      public void windowOpened(WindowEvent event)
      Invoked the first time a window is made visible. Not used.
      Specified by:
      windowOpened in interface WindowListener
      Parameters:
      event - The window event.
    • windowClosing

      public void windowClosing(WindowEvent event)
      Handles window closing event. Performs function exitApplication().
      Specified by:
      windowClosing in interface WindowListener
      Parameters:
      event - The window event.
    • windowClosed

      public void windowClosed(WindowEvent event)
      Invoked when a window has been closed as the result of calling dispose on the window. Not used.
      Specified by:
      windowClosed in interface WindowListener
      Parameters:
      event - The window event.
    • windowIconified

      public void windowIconified(WindowEvent event)
      Invoked when a window is changed from a normal to a minimized state. For many platforms, a minimized window is displayed as the icon specified in the window's iconImage property. Not used.
      Specified by:
      windowIconified in interface WindowListener
      Parameters:
      event - The window event.
    • windowDeiconified

      public void windowDeiconified(WindowEvent event)
      Invoked when a window is changed from a minimized to a normal state. Not used.
      Specified by:
      windowDeiconified in interface WindowListener
      Parameters:
      event - The window event.
    • windowActivated

      public void windowActivated(WindowEvent event)
      Invoked when the window is set to be the user's active window, which means the window (or one of its subcomponents) will receive keyboard events. Not used.
      Specified by:
      windowActivated in interface WindowListener
      Parameters:
      event - The window event.
    • windowDeactivated

      public void windowDeactivated(WindowEvent event)
      Invoked when a window is no longer the user's active window, which means that keyboard events will no longer be delivered to the window or its subcomponents. Not used.
      Specified by:
      windowDeactivated in interface WindowListener
      Parameters:
      event - The window event.
    • actionPerformed

      public void actionPerformed(ActionEvent event)
      Handles menu and toolbar item choices.
      Specified by:
      actionPerformed in interface ActionListener
      Parameters:
      event - The action even that triggers this function.
    • lostOwnership

      public void lostOwnership(Clipboard clipboard, Transferable contents)
      Notifies this object that it is no longer the owner of the contents of the clipboard.
      Specified by:
      lostOwnership in interface ClipboardOwner
      Parameters:
      clipboard - The clipboard that is no longer owned.
      contents - The contents which this owner had placed on the clipboard.
    • dragGestureRecognized

      public void dragGestureRecognized(DragGestureEvent event)
      A DragGestureRecognizer has detected a platform-dependent drag initiating gesture. It is notifying this listener in order for it to initiate the action for the user.
      Specified by:
      dragGestureRecognized in interface DragGestureListener
      Parameters:
      event - The DragGestureEvent describing the gesture that has just occurred.
    • dragDropEnd

      public void dragDropEnd(DragSourceDropEvent event)
      This message goes to DragSourceListener, informing it that the dragging has ended.
      Specified by:
      dragDropEnd in interface DragSourceListener
      Parameters:
      event - Details about the drop event.
    • dragEnter

      public void dragEnter(DragSourceDragEvent event)
      This message goes to DragSourceListener, informing it that the dragging has entered the DropSite.
      Specified by:
      dragEnter in interface DragSourceListener
      Parameters:
      event - Details about the drag event.
    • dragExit

      public void dragExit(DragSourceEvent event)
      This message goes to DragSourceListener, informing it that the dragging has exited the DropSite.
      Specified by:
      dragExit in interface DragSourceListener
      Parameters:
      event - Details about the drag event.
    • dragOver

      public void dragOver(DragSourceDragEvent event)
      This message goes to DragSourceListener, informing it that the dragging is currently ocurring over the DropSite.
      Specified by:
      dragOver in interface DragSourceListener
      Parameters:
      event - Details about the drag event.
    • dropActionChanged

      public void dropActionChanged(DragSourceDragEvent event)
      This is invoked when the user changes the dropAction.
      Specified by:
      dropActionChanged in interface DragSourceListener
      Parameters:
      event - Details about the drop action event.
    • dragEnter

      public void dragEnter(DropTargetDragEvent event)
      This is invoked when you are dragging over the DropSite.
      Specified by:
      dragEnter in interface DropTargetListener
      Parameters:
      event - Details about the drag event.
    • dragExit

      public void dragExit(DropTargetEvent event)
      Thi ss invoked when you are exit the DropSite without dropping.
      Specified by:
      dragExit in interface DropTargetListener
      Parameters:
      event - Details about the drag event.
    • dragOver

      public void dragOver(DropTargetDragEvent event)
      This is invoked when a drag operation is going on.
      Specified by:
      dragOver in interface DropTargetListener
      Parameters:
      event - Details about the drag event.
    • drop

      public void drop(DropTargetDropEvent event)
      This is invoked when a drop has occurred.
      Specified by:
      drop in interface DropTargetListener
      Parameters:
      event - The drop event.
    • dropActionChanged

      public void dropActionChanged(DropTargetDragEvent event)
      This is invoked if the user modifies the current drop gesture.
      Specified by:
      dropActionChanged in interface DropTargetListener
      Parameters:
      event - Details about the drop action change event.
    • main

      public static void main(String[] args)
      The entry point for this application. Creates a new FilterBuilder and makes it visible.
      Parameters:
      args - [0] optional URL to operate on.