Abstract:
A user-definable pattern searching apparatus is presented, composed of a graphical user interface to capture user pattern definitions and create a Pgraph of nodes defining the search and a traversal engine to use the Pgraph to search an arbitrary input stream of character patterns.

Description:
RELATED U.S. APPLICATIONS  
       [0001]    This application supplements and completes Provisional Application No. 60/174,569, filed Jan. 5, 2000. 
     
    
     
       BACKGROUND OF THE INVENTION  
         [0002]    The present invention relates to information processing systems, in particular, to search and retrieval methods for examining sets of character streams. In this field, sets of streams are searched for any or all of a plurality of bit patterns. This invention is applicable to document systems, databases, word processors, and other data and software sets.  
         SUMMARY OF THE INVENTION  
         [0003]    The Pattern Recognition and Filtering Tool (PRFT) is unique in that it searches for and recognizes patterns, not character strings.  
           [0004]    Character strings are a type (subset) of patterns—all characters strings are patterns but not vice versa.  
           [0005]    A pattern is a sequence of subpatterns, each subpattern defined by a value set, and a min and a max # of occurrences of values contained in the set. One of the important side effects of this definition of a pattern is that it allows the tool to handle fixed-length fields/records when min=max.  
           [0006]    The PRFT processes a single input stream or file at a time. z The PRFT can be configured to handle sequences of input streams or files.  
           [0007]    It is an object of this invention to provide a software system that has a configurable pattern recognition facility for character strings in computer data streams.  
           [0008]    It is a further object of this invention to provide a character-pattern-driven search engine that can search an input stream in accordance with a pre-defined “Pgraph” describing a series of actions to be taken.  
           [0009]    It is a further object of this invention to provide a graphical user interface for the pattern recognition configuration that is easy to use and intuitive.  
           [0010]    It is a further object of this invention to provide a pattern searching mechanism that will handle search string ambiguity. 
       
    
    
     DESCRIPTION OF THE PREFERRED EMBODIMENT  
       [0011]    Refer to the attached copy of the preferred embodiment description, submitted with the provisional application, No. 60/174,569, for a description of the preferred embodiment of this invention.  
         [0012]    Description of Configurable Pattern Recognition and Filtering Tool (CPRFT)  
         [0013]    The “Configurable Pattern Recognition and Filtering Tool” software utility consists of two principal components:  
         [0014]    1. The Configuration Facility.  
         [0015]    2. The PRF “Engine”.  
         [0016]    The Configuration Facility  
         [0017]    The Configuration Facility supports definition of the following data items required by the PRF Engine:  
         [0018]    Sets  
         [0019]    Patterns  
         [0020]    a PGraph (composed of Nodes and Links)  
         [0021]    Variables  
         [0022]    Actions  
         [0023]    Input streams  
         [0024]    Output streams  
         [0025]    The Configuration Facility supports definition of all of the data required by the PRF Engine. The definition created by the Configuration Facility can be saved to a file for later use. A free-format textual “comment” can be placed in and associated with the definition.  
         [0026]    When the appropriate data items have been defined the PRF Engine can be invoked to perform a PRF “run”.  
         [0027]    Sets  
         [0028]    A set is a set of values. It is defined by the user as a sequence of individual values and value ranges. The PRF Engine currently supports sets of byte values (valid range: 0-255). Every set is identified by a unique user-defined textual identifier, or tag.  
         [0029]    Patterns  
         [0030]    A pattern is defined by the user as a sequence of subpatterns. A subpattern is defined by 1) an associated set, 2) a minimum length and 3) a maximum length. A subpattern is said to be recognized if the consecutive sequence of input stream values at the current input stream location, of at least the minimum subpattern length, are all elements of the subpattern&#39;s associated set. Input stream values following the recognized subpattern, that are elements of the subpattern&#39;s associated set, may be included as part of the recognized subpattern up to and including the subpattern&#39;s maximum length. The “may be” in the preceding sentence is elaborated upon later, under the “Ambiguity” heading.  
         [0031]    A pattern is said to be recognized if all of its subpatterns are recognized, sequentially, in the input stream:  
         [0032]    TemplnputStreamlndex=InputStreamindex (current input stream location)  
         [0033]    For each subpattern in the pattern:  
                                                                                 {                If the subpattern is recognized           Then - continue:                Advance TempInputStreamIndex to the next input stream value           for each input stream value recognized as part of the subpattern.                Else - this pattern is not recognized - terminate the           “For each subpattern” loop.            }       If all of the pattern&#39;s subpatterns are recognized       Then -                The pattern is recognized ...           Process the pattern,           InputStreamIndex = TempInputStreamIndex (advance the input           stream location past the recognized pattern).                      
 
         [0034]    A string is a special case of a pattern—a sequence of characters that can be typed in at a computer keyboard. The Configuration Facility allows strings to be used anywhere patterns are. This special support of string definition is provided so that a simple character string pattern need not be defined (cumbersomely) as a sequence of subpatterns. A string is recognized if it occurs at the current input stream location. Case-sensitivity can be enabled or disabled for string recognition.  
         [0035]    A pattern of zero maximum length can be defined. This pattern matches either the beginning or end of the input stream, depending on the input stream location. A zero-length pattern doesn&#39;t match any input stream values; it is considered recognized before any input stream values have been examined and after all input stream values have been examined.  
         [0036]    Every pattern is identified by a unique user-defined tag.  
         [0037]    PGraph  
         [0038]    PRF Engine processing is driven by a single PGraph, which is composed of one or more user-defined nodes connected to each other by user-defined links. Any two nodes in the graph can be connected by a link. A link connects exactly two nodes and is directional, so that for each link one node is the “from” node and the other is the “to” node. A pair of nodes A and B can be linked “circularly”, i.e. there can be a link from A to B, and from B to A. There is no requirement that all nodes be linked somehow to other nodes. Single nodes or connected groups of nodes can be left disconnected from other nodes/groups (“parked”), awaiting activation by the creation of a link or by the “assign start node” action (described later).  
         [0039]    At any time during a PRF run exactly one node is the current node. At the start of a PRF run the current node is set to the user-definabIe start node. During a PRF run the PGraph is traversed: one of the nodes the current node is linked to may become the new current node, depending on the next node pattern recognized in the input stream.  
         [0040]    Exactly one node in the PGraph is defined as the start node, which identifies the starting point of the PGraph traversal. The start node can be assigned/reassigned by the “assign start node” action during a PRF run. The start node is user-definable but a default is assigned by the Configuration Facility (e.g. the first node created).  
         [0041]    Nodes  
         [0042]    A node has associated with it exactly one pattern (or string). This node-pattern association is user-defined. A node is said to be recognized if its associated pattern/string has been recognized in the input stream.  
         [0043]    A node can be identified by a user-defined tag. This tag is used to refer to the node elsewhere in the definition created by the Configuration Facility. The tag on a node is optional, however, and need not be unique. If a group of two or more nodes shares the same tag, that tag refers to the node in that group that was most recently recognized in the input stream. If none of the nodes grouped by a non-unique tag has been recognized in the current input stream, that tag refers to a null node whose pattern length is zero.  
         [0044]    A node has associated with it zero or more user-defined actions, which determine processing to be performed when the node is recognized in the input stream.  
         [0045]    Every node has an ordinal number. This number is unique for each node, ranging from zero to the number of nodes in the PGraph. The Configuration Facility provides defaults for the node ordinal number (e.g. order of node creation), but the user can also define the node ordinal numbers to facilitate, for example, node selection via use of the tab key (“tabbing through” the nodes). The node ordinal numbers currently have no effect on the operation of the PRF Engine—they are used solely by the Configuration Facility.  
         [0046]    Links  
         [0047]    A link connects two nodes. It is directional, establishing a “from” and a “to” node. This direction determines the order of PGraph node traversal during a PRF run.  
         [0048]    Every link has a number. The links emanating from a given node are numbered uniquely to establish the order for checking which of the nodes the given node is linked “to” will become the next current node during PGraph traversal.  
         [0049]    The Configuration Facility provides defaults for the link numbers (e.g. order of link creation), but the link number can also be defined by the user. If the user specifies link number N for a link, and N has already been assigned to another link emanating from the same node, the Configuration Facility will increment by one the number of all links emanating from that node whose link number is greater than or equal to N before assigning N to the newly-numbered link, thereby preserving link number uniqueness.  
         [0050]    The Configuration Facility prevents the creation of duplicate links. A duplicate link is one that has the same “from” and “to” nodes as an existing link.  
         [0051]    Variables  
         [0052]    A variable is a data item that can be assigned an initial value and reassigned values during a PRF run. Currently supported variable types include:  
         [0053]    Strings  
         [0054]    Byte sequences  
         [0055]    Every variable is identified by a unique user-defined tag.  
         [0056]    A Counter is a variable of type integer.  
         [0057]    Actions  
         [0058]    Actions can be invoked at various points during a PRF run: before or after the run itself, before or after processing an input stream, and when a node is recognized. Actions are user-defined but are derived from a predefined list of available actions, including:  
         [0059]    Transfer input stream (recognized) data associated with a node to an output stream  
         [0060]    Transfer special data (e.g. stream/file name) to an output stream  
         [0061]    Set, increment, or transfer to an output stream the value of a variable or a counter  
         [0062]    Assign the start node  
         [0063]    Execute a user-defined action  
         [0064]    Execute a user-defined group of actions (a procedure)  
         [0065]    Halt processing of the current input stream  
         [0066]    Halt the PRF run  
         [0067]    The “transfer to an output stream” actions can also be configured to transfer output to, for example, the Windows clipboard and other data destinations.  
         [0068]    Each action type requires certain parameters:  
                                                       Transfer data to output stream   data identifier (e.g. node tag)               output stream tag           Variable operations   variable/counter tag               value           User-defined procedure   procedure (action group) tag               execute once per stream (y/n)           User-defined action   action identifier           Assign start node   node tag           Halt   no parameters required                      
 
         [0069]    The list of potential actions is practically limitless and will be revised and enhanced in subsequent releases of CPRFT.  
         [0070]    Input Streams  
         [0071]    The PRF Engine processes a single input stream (e.g. file) at a time. A single PRF run processes a succession of one or more input streams. The Configuration Facility supports definition of the input stream sequence, composed of one or more stream specifications.  
         [0072]    Output Streams  
         [0073]    The PRF Engine can output data to any number of streams. Every output stream is identified by a unique user-defined tag and an access mode (e.g. overwrite, append, etc.).  
         [0074]    PGraph graphical definition  
         [0075]    The Configuration Facility supports graphical definition of the PGraph. [Note: in the following discussion, the term “click” refers to a single click of the left mouse buffon.] Nodes can be placed on the Configuration Facility drawing surface (e.g. the Windows client area) by double-clicking at the desired node location. A node can be selected for modification by single-licking on its graphic. The node selection can also be changed by pressing the tab key, which will cause the node selection to “traverse” the PGraph in node ordinal number order, ascending or descending ordinal number order for right or left tab, respectively. A node&#39;s property (attribute) menu can be accessed by selecting the node and pressing &lt;Enter&gt;, or by double-licking on the node&#39;s graphic.  
         [0076]    A node can be moved on the drawing surface by selecting it and dragging it with the left mouse button held down. A node can also be moved by selecting it and using the left/right/up/down arrow keys to perform fine adjustments of the node location. A node can be deleted by selecting it and pressing the &lt;Delete&gt; key, or by accessing the node&#39;s property menu and selecting the “Delete” menu option. Node properties (node tag, pattern, string, “links to”, start node, actions, ordinal number, etc.) can be modified using dialogs accessed via options in the node&#39;s property menu.  
         [0077]    Node links are defined by selecting the “Link to” option of the “from” node property menu. “Link to” initiates a drawing operation, creating a line originating at the selected node (the “from” node) and terminating at the mouse location. The line termination point follows mouse movements until a “to” node for the link is selected. The “to” node for the link is selected by single-clicking on any other node in the PGraph. The link drawing operation can be canceled at any time by single-clicking anywhere but on another node. The user merely chooses the two nodes to connect by a link; the Configuration Facility determines how to draw the link once the “to” node is selected.  
         [0078]    Every link has a graphical representation, drawn by the Configuration Facility as connected line segments (3, currently) with an arrow adjoining and pointing to the “to” node. A small box is drawn near the midpoint of the link graphic; this box displays the link&#39;s number. Link selection is performed in a similar manner to node selection: clicking on the link&#39;s box graphic selects the link; a link&#39;s property (attribute) menu can be accessed by selecting the link and pressing &lt;Enter&gt;, or by double-clicking on the links box graphic. A link can be deleted by selecting it and pressing the &lt;Delete&gt; key, or by accessing the link&#39;s property menu and selecting the “Delete” menu option. If a node is deleted all links to and from that node are automatically deleted. Link properties (link number, etc.) can be modified using dialogs accessed via the link&#39;s property menu. Links are automatically redrawn by the Configuration Facility when nodes are moved or deleted by the user.  
         [0079]    Configuration data not acquired from the user graphically (e.g. sets, patterns, variables, actions, streams) is entered tabularly via menu selections and dialogs.  
         [0080]    User Input Checking  
         [0081]    The Configuration Facility enforces, and facilitates, the correctness and consistency of user input. Data items that refer to other data items (via tags, usually) must be defined after the items they refer to. The user cannot make a reference to an undefined tag. Context-sensitive help is available wherever, for example, a tag must be chosen: upon requesting help (e.g. pressing the &lt;F1&gt; key) the user is presented with a list displaying the appropriate tags available for use in the current data entry context.  
         [0082]    The PRF Engine  
         [0083]    During a PRF run the PRF Engine processes the user-defined sequence of input streams, one stream at a time. The current input stream is “opened” and the PRF Engine sets its input stream location (the current position within the input stream, referred to hereafter as the stream location) to the beginning of the input stream, i.e. position zero. The current node is also set to the start node.  
         [0084]    At this point PGraph traversal begins. The stream location is advanced until the start node&#39;s pattern is recognized, or until the end of the input stream is encountered.  
         [0085]    When the current node is recognized (i.e. when the pattern associated with the current node is recognized at the current input stream location) the PRF Engine does several things:  
         [0086]    It performs the actions associated with the current node,  
         [0087]    it attempts to determine the next node to become the current node in the PGraph traversal.  
         [0088]    Performing the actions simply means executing in sequence the list of actions (if there are any) associated with the current node.  
         [0089]    To select the next current node, the PRF Engine considers the “to” nodes of each link emanating “from” the current node. Each of these “to” nodes is a potential next node. The potential next nodes are examined in link number order. When one of these potential next nodes is recognized in the input stream immediately following the values recognized as the current node&#39;s pattern, that potential next node becomes the current node. If no potential next node is recognized the start node is selected as the next current node and the PRF Engine once again scans the input stream in an attempt to recognize the start node.  
         [0090]    PGraph traversal for the current input stream ends when the stream location can no longer be advanced within the input stream, i.e. when the end of the input stream is encountered. PGraph traversal can also be terminated by user-defined “halt” actions.  
         [0091]    Ambiguity  
         [0092]    Every subpattern of a pattern has a minimum and maximum length. If a subpattern&#39;s maximum length exceeds its minimum length a potential ambiguity arises. Beyond the minimum length, and up to and including the maximum length, input stream values contained in the current subpattern&#39;s set may also be contained in the next subpaftem&#39;s set (if there is a next subpattern), or may be recognized as (the start of) one of the potential next nodes&#39; patterns (if there are any potential next nodes). The question arises: should these ambiguous input stream values be “assigned to” the current subpaftem, or to the next subpaftem/potential next node to which they may also be assigned? In other words, when should the PRF Engine, in such an ambiguous situation, make the transition from the current subpaftem to the next possible state? Among the possibilities are:  
         [0093]    Making the transition to the next state as soon as possible (ASAP),  
         [0094]    making the transition as late as possible (ALAP).  
         [0095]    The PRF Engine can support both “ASAP” and “ALAP” transition modes. The current version makes transitions ALAP if the next state is a subpattern (i.e. if the subpattern being examined is not the last one in its containing pattern). Transitions are ASAP if the next state is a potential next node (i.e. if the subpattern being examined is the last one in its containing pattern). Experimentation has shown this combination to be effective, but options may be provided to make these transition modes user-definable in a future version of CPRFT. “Transition ALAP”, unlike “ASAP”, regards only the value at the current input stream location, i.e. doesn&#39;t look ahead. Input stream values are associated with the current subpattern until one of the following becomes true:  
         [0096]    The input stream value is not a member of the subpatter&#39;s set,  
         [0097]    the subpattern&#39;s maximum length has been attained,  
         [0098]    the end of the input stream has been reached.  
         [0099]    “Transition ASAP” between nodes allows, for example, definition of a subpattern of “anythings” (with a set containing all possible values) followed by a next state (potential next node) whose pattern is specific, thereby instructing the PRF Engine to effectively look ahead and “seek” the specific pattern.  
         [0100]    Implementation Details  
         [0101]    Menus  
         [0102]    CPRFT has a single standard main menu, consisting of:  
                                                 Top-level           options:   Submenus:                                Definition               File           New   Create a new definition           Open   Open an existing definition           Save   Save the current definition           Save as   Save the current definition as . . .           Comment   Edit the current definition&#39;s comment           Exit   Exit CPRFT       Input/       Output           Input   Define input stream specifications -           streams   Single dialog: list of tags, stream                        specifications, “search                        subdirectories” checkboxes           Output   Define output stream specifications -           streams   Single dialog: list of tags, stream                        specifications, “append”                        checkboxes       Definitions           Sets   Define sets -               Primary dialog:  list of set tags               Secondary dialog: list of start &amp; end                        values           Patterns   Define patterns -               Primary dialog:  list of pattern                         tags               Secondary dialog: list of associated sets,                        min &amp; max counts           Variables   Define variables -               Single dialog: list of variable tags,                        types, initial values           Counters   Define counters -               Single dialog: list of counter tags,                        initial values           1   Define actions to perform before a PRF run -           Pre-run   Single dialog: list of action types &amp;           actions            parameters           2   Define actions to perform before processing           Pre-stream   each input stream -           actions   Single dialog: list of action types &amp;                        parameters           3   Define actions to perform after processing each           Post-   input stream -           stream   Single dialog: list of action types &amp;           actions            parameters           4   Define actions to perform after a PRF run -           Post-run   Single dialog: list of action types &amp;           actions            parameters           Action   Define action groups (procedures) -           groups   Primary dialog:  list of action                       group tags               Secondary dialog: list of action types &amp;                        parameters       Run           Run   Run the PRF Engine using the current               definition       View           &lt;Output   View output streams (output stream tag           streams&gt;   selection)           Status   View program status information       Options           File   Define the file viewing program           viewer   (e.g. notepad.exe)       Help           Index   View the CPRFT help file           Using   System instructions on using help           help           About   Brief description of the CPRFT program                  
 
         [0103]    Every node has a single properties menu, consisting of:  
                                         Top-level       options:                                Properties   Define node properties (tag, pattern, ordinal number)       String   Define an optional string associated with the node (string,           “ignore case” checkbox) - see note below       Actions   Define actions associated with the node (list of action           types &amp; parameters)       Link to . . .   Create a link to another node       Start node   Designate the node as the start node       Delete   Delete the node                                  
 
         [0104]    Every link has a single properties menu, consisting of:  
                                                             Top-level           options:                                        Renumber   Define the link&#39;s number           Delete   Delete the link                      
 
         [0105]    Sets  
         [0106]    CPRFT currently supports sets of byte values (valid range: 0-255) stored and retrieved as bits in a 256-element (bit) map.  
         [0107]    Tag case sensitivity  
         [0108]    Tags are case-sensitive. For instance, tags “SearchString” and “searchstring” are distinct tags.