Package org.elasticsearch.xpack.esql.core.expression.predicate.regex

Class WildcardPattern

java.lang.Object

org.elasticsearch.xpack.esql.core.expression.predicate.regex.AbstractStringPattern

org.elasticsearch.xpack.esql.core.expression.predicate.regex.WildcardPattern

All Implemented Interfaces:

Writeable, StringPattern, NodeStringRenderable

public class WildcardPattern
extends AbstractStringPattern
implements Writeable

Similar to basic regex, supporting '?' wildcard for single character (same as regex ".") and '*' wildcard for multiple characters (same as regex ".*")

Allows escaping based on a regular char.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WildcardPattern.Shape	Classification of a WildcardPattern into the simple fast-path shapes.

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
WildcardPattern(String pattern)
WildcardPattern(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	asIndexNameWildcard()	Returns the pattern in (IndexNameExpressionResolver) wildcard format.
String	asJavaRegex()	Returns the pattern in (Java) regex format.
String	asLuceneWildcard()	Returns the pattern in (Lucene) wildcard format.
protected org.apache.lucene.util.automaton.Automaton	doCreateAutomaton(boolean ignoreCase)
boolean	equals(Object obj)
int	hashCode()
void	nodeString(StringBuilder sb, Node.NodeStringFormat format, NodeStringMapper mapper)	Renders the wildcard quoted, routing literal runs through mapper.column while keeping the wildcard metacharacters (* ? % _) and escapes structural.
String	pattern()	Returns the pattern as it was defined by the user.
WildcardPattern.Shape	shape()	Classify this pattern into one of the affix-only fast-path shapes, unwrapping backslash escapes in a single pass.
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.predicate.regex.AbstractStringPattern

createAutomaton, exactMatch, extractPrefix, extractSuffix, matchesAll

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WildcardPattern

public WildcardPattern(String pattern)

WildcardPattern

public WildcardPattern(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

pattern

public String pattern()

Description copied from interface: StringPattern

Returns the pattern as it was defined by the user.

Specified by:

pattern in interface StringPattern

nodeString

public void nodeString(StringBuilder sb,
 Node.NodeStringFormat format,
 NodeStringMapper mapper)

Renders the wildcard quoted, routing literal runs through mapper.column while keeping the wildcard metacharacters (* ? % _) and escapes structural. Under NodeStringMapper.IDENTITY this reproduces the raw pattern.

Specified by:

nodeString in interface NodeStringRenderable

Overrides:

nodeString in class AbstractStringPattern

doCreateAutomaton

protected org.apache.lucene.util.automaton.Automaton doCreateAutomaton(boolean ignoreCase)

Specified by:

doCreateAutomaton in class AbstractStringPattern

asJavaRegex

public String asJavaRegex()

Description copied from interface: StringPattern

Returns the pattern in (Java) regex format.

Specified by:

asJavaRegex in interface StringPattern

asLuceneWildcard

public String asLuceneWildcard()

Returns the pattern in (Lucene) wildcard format.

asIndexNameWildcard

public String asIndexNameWildcard()

Returns the pattern in (IndexNameExpressionResolver) wildcard format.

shape

public WildcardPattern.Shape shape()

Classify this pattern into one of the affix-only fast-path shapes, unwrapping backslash escapes in a single pass. The result is one of WildcardPattern.Shape.Prefix, WildcardPattern.Shape.Suffix, WildcardPattern.Shape.Contains, or WildcardPattern.Shape.General.INSTANCE. The first three carry the literal segment so callers can dispatch to a startsWith / endsWith / substring-search evaluator without building an Automaton; General signals that the pattern does not match any simple shape (multiple unescaped *s with text between them, any unescaped ?, escaped-only patterns with no wildcards, dangling backslashes, etc.) and the caller should fall back to the automaton path.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object