Package org.apache.lucene.util.automaton
Class CompiledAutomaton
java.lang.Object
org.apache.lucene.util.automaton.CompiledAutomaton
- All Implemented Interfaces:
Accountable
Immutable class holding compiled details for a given Automaton. The Automaton is deterministic,
must not have dead states but is not necessarily minimal.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Automata are compiled into different internal forms for the most efficient execution depending upon the language they accept. -
Field Summary
Modifier and TypeFieldDescriptionfinal Automaton
Two dimensional array of transitions, indexed by state number for traversal.final BytesRef
Shared common suffix accepted by the automaton.final Boolean
Indicates if the automaton accepts a finite set of strings.final ByteRunAutomaton
Matcher for quickly determining if a byte[] is accepted.final int
Which state, if any, accepts all suffixes, else -1.final BytesRef
ForCompiledAutomaton.AUTOMATON_TYPE.SINGLE
this is the singleton term.If simplify is true this will be the "simplified" type; else, this is NORMALFields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
Constructor Summary
ConstructorDescriptionCompiledAutomaton
(Automaton automaton) Create this, passing simplify=true and finite=null, so that we try to simplify the automaton and determine if it is finite.CompiledAutomaton
(Automaton automaton, Boolean finite, boolean simplify) Create this.CompiledAutomaton
(Automaton automaton, Boolean finite, boolean simplify, int determinizeWorkLimit, boolean isBinary) Create this. -
Method Summary
Modifier and TypeMethodDescriptionboolean
floor
(BytesRef input, BytesRefBuilder output) Finds largest term accepted by this Automaton, that's <= the provided input term.getTermsEnum
(Terms terms) int
hashCode()
long
Return the memory usage of this object in bytes.void
visit
(QueryVisitor visitor, Query parent, String field) Report back to a QueryVisitor how this automaton matches termsMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
Field Details
-
type
If simplify is true this will be the "simplified" type; else, this is NORMAL -
term
ForCompiledAutomaton.AUTOMATON_TYPE.SINGLE
this is the singleton term. -
runAutomaton
Matcher for quickly determining if a byte[] is accepted. only valid forCompiledAutomaton.AUTOMATON_TYPE.NORMAL
. -
automaton
Two dimensional array of transitions, indexed by state number for traversal. The state numbering is consistent withrunAutomaton
. Only valid forCompiledAutomaton.AUTOMATON_TYPE.NORMAL
. -
commonSuffixRef
Shared common suffix accepted by the automaton. Only valid forCompiledAutomaton.AUTOMATON_TYPE.NORMAL
, and only when the automaton accepts an infinite language. This will be null if the common prefix is length 0. -
finite
Indicates if the automaton accepts a finite set of strings. Null if this was not computed. Only valid forCompiledAutomaton.AUTOMATON_TYPE.NORMAL
. -
sinkState
public final int sinkStateWhich state, if any, accepts all suffixes, else -1.
-
-
Constructor Details
-
CompiledAutomaton
Create this, passing simplify=true and finite=null, so that we try to simplify the automaton and determine if it is finite. -
CompiledAutomaton
Create this. If finite is null, we useOperations.isFinite(org.apache.lucene.util.automaton.Automaton)
to determine whether it is finite. If simplify is true, we run possibly expensive operations to determine if the automaton is one the cases inCompiledAutomaton.AUTOMATON_TYPE
. -
CompiledAutomaton
public CompiledAutomaton(Automaton automaton, Boolean finite, boolean simplify, int determinizeWorkLimit, boolean isBinary) Create this. If finite is null, we useOperations.isFinite(org.apache.lucene.util.automaton.Automaton)
to determine whether it is finite. If simplify is true, we run possibly expensive operations to determine if the automaton is one the cases inCompiledAutomaton.AUTOMATON_TYPE
. If simplify requires determinizing the automaton then at most determinizeWorkLimit effort will be spent. Any more than that will cause a TooComplexToDeterminizeException.
-
-
Method Details
-
getTermsEnum
- Throws:
IOException
-
visit
Report back to a QueryVisitor how this automaton matches terms -
floor
Finds largest term accepted by this Automaton, that's <= the provided input term. The result is placed in output; it's fine for output and input to point to the same bytes. The returned result is either the provided output, or null if there is no floor term (ie, the provided input term is before the first term accepted by this Automaton). -
hashCode
public int hashCode() -
equals
-
ramBytesUsed
public long ramBytesUsed()Description copied from interface:Accountable
Return the memory usage of this object in bytes. Negative values are illegal.- Specified by:
ramBytesUsed
in interfaceAccountable
-