Package monq.jfa

package monq.jfa

Main entry point to implement Finite Automata, deterministic and nondeterministic and use them for matching. There is an example program available.

A typical use of this package involves the following steps.

1. Creation of an NFA with an NfaBuilder:

   NfaBuilder<String> b = new NfaBuilder<>()
        .matchRegex("[a-z]+", "ALPHA")
        .or("[0-9]+", "NUM");

2. Compilation into a DFA with NfaBuilder.compileToDfa().

   Dfa dfa = b.compileToDfa()

3. Text matching with the Dfa methods:

   assertEquals("NUM", dfa.matchesAtStart("1234 bla bla"))

4. Or text filtering with DfaFilter.

Alternatively, for matching without the need to retrieve a value, see Regexp.

Related Packages

Package	Description
monq	Example programs: Example and Oooo which resembles grep/sed
monq.jfa.actions	Definition and implementations of actions to be stored in a Dfa to be executed on a match by Actions.HANDLER.
monq.jfa.filter	Classes to repetitively run Dfa.match(monq.jfa.CharSource, java.lang.StringBuilder) on some input and invoke a handler on the match.
monq.jfa.ooo	Support classes for Oooo.
monq.jfa.textparts	Historic code, needs rework.
monq.jfa.util	Historic code, needs rework.

Class	Description
Bla	asd;kfj alsdkjf lasdkjf laksdjf laksjdf laksjdf laskjdf lakdsjfalsdjf laskdjf lasdkjf lasdkfj alsdjkf alsdfjk asldfjk asdlfkj
CharSource	defines the the character source from which automaton matching reads the data.
CharTrans<T>	Interface of a data structure to map non-overlapping character ranges like 'a'-'f' to non-null objects.
CharUnaryOperator	A function to map one char to another.
CompileDfaException	Represents things that go wrong during compilation of an Nfa into a Dfa.
Dfa<T>	A deterministic finite automaton, with convenience methods to match text and/or lookup values stored for a matching text.
EmptyCharTrans<T>
FaToDot	Contains a static function to output a finite automaton as a graph to be printed by the dot utility.
Intervals<D>	Used to construct CharTrans objects of different implementations.
IntToObjectFunction<T>
Misc	Miscellaneous static functions.
Nfa<T>	Merely a holder for a start and a stop state as produced by NfaBuilder.pop().
NfaBuilder<T>	A builder for non-deterministic finite automata along the lines of Thompson's Construction and a compilation method to get a deterministic finite automaton.
NfaState<T>
PairStack<T>
PlainSet<E>	an implementation of Set based on a simple hashing scheme.
PrioritizedValueMerger<T>
RangeEntry<T>	Abstraction over the type of key/value pair stored in a CharTrans where the key is a character range given by its inclusive borders.
ReaderCharSource	Wraps a Reader or an input stream to provide a CharSource.
ReClassicParser	Implements the regular expression syntax classically used by monq.jfa.
RecordingMatcher<T>	A matcher looping on Dfa.transition(monq.jfa.CharSource), recording character positions when traversing a state which tests true for a given predicate.
Regexp	Convenience class for matching regular expressions with a Dfa.
ReParser	Defines the interface of a regular expression parser used by NfaBuilder.matchRegex(java.lang.CharSequence) and configured with NfaBuilder(ReParser, StateValueMerger, double)
ReSyntaxException	is thrown whenever a syntax error is found in a regular expression.
StateValueMerger<V>	Merges a list of values into one result.
StringCharSource	A CharSource for a String or a part of it.