Package org.htmlparser.parserapplications.filterbuilder.wrappers

Class RegexFilterWrapper

  • All Implemented Interfaces:
    java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.event.DocumentListener, NodeFilter
    public class RegexFilterWrapper
extends Filter
implements java.awt.event.ActionListener, javax.swing.event.DocumentListener
    Wrapper for RegexFilters.
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JComponent

        javax.swing.JComponent.AccessibleJComponent

      • 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 Description
      protected RegexFilter mFilter
      The underlying filter.
      static java.lang.Object[][] mMap
      Mapping for RegexFilter constants to strings.
      protected javax.swing.JTextArea mPattern
      Text to check for
      protected javax.swing.JComboBox mStrategy
      Combo box for strategy.

      • Fields inherited from class org.htmlparser.parserapplications.filterbuilder.Filter

        mWrappers

      • Fields inherited from class javax.swing.JComponent

        listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

      • Fields inherited from class java.awt.Component

        accessibleContext, 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

      Constructors 
      Constructor Description
      RegexFilterWrapper()
      Create a wrapper over a new RegexFilter.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean accept​(Node node)
      Predicate to determine whether or not to keep the given node.
      void actionPerformed​(java.awt.event.ActionEvent event)
      Invoked when an action occurs on the combo box.
      void changedUpdate​(javax.swing.event.DocumentEvent e)
      Handle a change update event.
      java.lang.String getDescription()
      Get the name of the filter.
      java.lang.String getIconSpec()
      Get the resource name for the icon.
      NodeFilter getNodeFilter()
      Get the underlying node filter object.
      NodeFilter[] getSubNodeFilters()
      Get the underlying node filter's subordinate filters.
      int indexToStrategy​(int index)
      Convert an index into a regex strategy.
      void insertUpdate​(javax.swing.event.DocumentEvent e)
      Handle an insert update event.
      void removeUpdate​(javax.swing.event.DocumentEvent e)
      Handle a remove update event.
      void setNodeFilter​(NodeFilter filter, Parser context)
      Assign the underlying node filter for this wrapper.
      void setSubNodeFilters​(NodeFilter[] filters)
      Assign the underlying node filter's subordinate filters.
      int strategyToIndex​(int strategy)
      Convert the regex strategy to an index into the map.
      java.lang.String strategyToString​(int strategy)
      Convert the regex strategy to a string.
      int stringToStrategy​(java.lang.String strategy)
      Convert a string to a regex strategy.
      java.lang.String toJavaCode​(java.lang.StringBuffer out, int[] context)
      Convert this filter into Java code.

      • Methods inherited from class javax.swing.JComponent

        addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • mMap

        public static java.lang.Object[][] mMap
        Mapping for RegexFilter constants to strings.

      • mFilter

        protected RegexFilter mFilter
        The underlying filter.

      • mPattern

        protected javax.swing.JTextArea mPattern
        Text to check for

      • mStrategy

        protected javax.swing.JComboBox mStrategy
        Combo box for strategy.

    • Constructor Detail

      • RegexFilterWrapper

        public RegexFilterWrapper()
        Create a wrapper over a new RegexFilter.

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Get the name of the filter.
        Specified by:
        getDescription in class Filter
        Returns:
        A descriptive name for the filter.

      • getIconSpec

        public java.lang.String getIconSpec()
        Get the resource name for the icon.
        Specified by:
        getIconSpec in class Filter
        Returns:
        The icon resource specification.

      • getNodeFilter

        public NodeFilter getNodeFilter()
        Get the underlying node filter object.
        Specified by:
        getNodeFilter in class Filter
        Returns:
        The node filter object suitable for serialization.

      • setNodeFilter

        public void setNodeFilter​(NodeFilter filter,
                          Parser context)
        Assign the underlying node filter for this wrapper.
        Specified by:
        setNodeFilter in class Filter
        Parameters:
        filter - The filter to wrap.
        context - The parser to use for conditioning this filter. Some filters need contextual information to provide to the user, i.e. for tag names or attribute names or values, so the Parser context is provided.

      • getSubNodeFilters

        public NodeFilter[] getSubNodeFilters()
        Get the underlying node filter's subordinate filters.
        Specified by:
        getSubNodeFilters in class Filter
        Returns:
        The node filter object's contained filters.

      • setSubNodeFilters

        public void setSubNodeFilters​(NodeFilter[] filters)
        Assign the underlying node filter's subordinate filters.
        Specified by:
        setSubNodeFilters in class Filter
        Parameters:
        filters - The filters to insert into the underlying node filter.

      • toJavaCode

        public java.lang.String toJavaCode​(java.lang.StringBuffer out,
                                   int[] context)
        Convert this filter into Java code. Output whatever text necessary and return the variable name.
        Specified by:
        toJavaCode in class Filter
        Parameters:
        out - The output buffer.
        context - Three integers as follows:
      • indent level - the number of spaces to insert at the beginning of each line
      • filter number - the next available filter number
      • filter array number - the next available array of filters number
        • Returns:
        The variable name to use when referencing this filter (usually "filter" + context[1]++)

      • strategyToString

        public java.lang.String strategyToString​(int strategy)
        Convert the regex strategy to a string.
        Parameters:
        strategy - The regex strategy.
        Returns:
        A string for display in the GUI or in the Java program.

      • stringToStrategy

        public int stringToStrategy​(java.lang.String strategy)
        Convert a string to a regex strategy.
        Parameters:
        strategy - The string equivalent of a regex strategy.
        Returns:
        The regex strategy to use in executing the regular expression.

      • strategyToIndex

        public int strategyToIndex​(int strategy)
        Convert the regex strategy to an index into the map.
        Parameters:
        strategy - The regex strategy.
        Returns:
        The index of the regex strategy in the map.

      • indexToStrategy

        public int indexToStrategy​(int index)
        Convert an index into a regex strategy.
        Parameters:
        index - The index of the regex strategy in the map.
        Returns:
        The regex strategy at that inxdex.

      • accept

        public boolean accept​(Node node)
        Predicate to determine whether or not to keep the given node. The behaviour based on this outcome is determined by the context in which it is called. It may lead to the node being added to a list or printed out. See the calling routine for details.
        Specified by:
        accept in interface NodeFilter
        Parameters:
        node - The node to test.
        Returns:
        true if the node is to be kept, false if it is to be discarded.

      • actionPerformed

        public void actionPerformed​(java.awt.event.ActionEvent event)
        Invoked when an action occurs on the combo box.
        Specified by:
        actionPerformed in interface java.awt.event.ActionListener
        Parameters:
        event - Details about the action event.

      • insertUpdate

        public void insertUpdate​(javax.swing.event.DocumentEvent e)
        Handle an insert update event.
        Specified by:
        insertUpdate in interface javax.swing.event.DocumentListener
        Parameters:
        e - Details about the insert event.

      • removeUpdate

        public void removeUpdate​(javax.swing.event.DocumentEvent e)
        Handle a remove update event.
        Specified by:
        removeUpdate in interface javax.swing.event.DocumentListener
        Parameters:
        e - Details about the remove event.

      • changedUpdate

        public void changedUpdate​(javax.swing.event.DocumentEvent e)
        Handle a change update event.
        Specified by:
        changedUpdate in interface javax.swing.event.DocumentListener
        Parameters:
        e - Details about the change event.