Class Pattern

  • Direct Known Subclasses:
    GenericByteSequencePattern

    public class Pattern
    extends DittedBitSequence
    Pattern is an association of a DittedBitSequence to match, a set of post rules after a match is found that must be satisfied, and a set of actions to be taken if the pattern matches. These patterns can be restored from an XML file.
    • Constructor Detail

      • Pattern

        public Pattern()
        Construct an empty pattern. Use XML to initialize
      • Pattern

        public Pattern​(DittedBitSequence seq,
                       int offset,
                       PostRule[] postArray,
                       MatchAction[] matchArray)
        Construct the pattern based on a DittedByteSequence a match offset, post matching rules, and a set of actions to take when the match occurs.
        Parameters:
        seq - DittedByteSequence
        offset - offset from the actual match location to report a match
        postArray - post set of rules to check for the match
        matchArray - MatchActions to apply when a match occurs
    • Method Detail

      • getPostRules

        public PostRule[] getPostRules()
      • getMatchActions

        public MatchAction[] getMatchActions()
      • setMatchActions

        public void setMatchActions​(MatchAction[] actions)
      • getMarkOffset

        public int getMarkOffset()
      • restoreXmlAttributes

        public static void restoreXmlAttributes​(java.util.ArrayList<PostRule> postrulelist,
                                                java.util.ArrayList<MatchAction> actionlist,
                                                XmlPullParser parser,
                                                PatternFactory pfactory)
                                         throws java.io.IOException
        Restore the PostRule and the MatchAction tags
        Parameters:
        parser - is the parser at the start of tags
        pfactory - is the factory for the PostRule and MatchAction objects
        Throws:
        java.io.IOException
      • restoreXml

        public void restoreXml​(XmlPullParser parser,
                               PatternFactory pfactory)
                        throws java.io.IOException
        Throws:
        java.io.IOException
      • readPatterns

        public static void readPatterns​(ResourceFile file,
                                        java.util.ArrayList<Pattern> patlist,
                                        PatternFactory pfactory)
                                 throws org.xml.sax.SAXException,
                                        java.io.IOException
        Read patterns from specified file
        Parameters:
        file - pattern file
        patlist - list for patterns to be added to
        pfactory - optional factory for use in parsing PostRule and MatchAction elements. If null such elements may not be present.
        Throws:
        org.xml.sax.SAXException
        java.io.IOException
      • readPostPatterns

        public static void readPostPatterns​(java.io.File file,
                                            java.util.ArrayList<Pattern> patternList,
                                            PatternFactory pfactory)
                                     throws org.xml.sax.SAXException,
                                            java.io.IOException
        Read just the post patterns from the tags
        Parameters:
        file - is the file to read from
        patternList - collects the resulting Pattern objects
        pfactory - is the factory for constructing postrules and matchactions
        Throws:
        java.io.IOException
        org.xml.sax.SAXException