Package org.elasticsearch.xpack.esql.core.tree

Class Source

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Source

All Implemented Interfaces:

Writeable, WarningSourceLocation

public final class Source
extends Object
implements Writeable, WarningSourceLocation

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Source	EMPTY

Constructor Summary

Constructors

Constructor	Description
Source(int line, int charPositionInLine, String text)
Source(Location location, String text)
Source(Location location, String text, String viewName)

Method Summary

Modifier and Type	Method	Description
int	columnNumber()
boolean	equals(Object obj)
int	hashCode()
int	lineNumber()
static Source	readEmpty(StreamInput in)	Read the components of a Source and throw it away, returning EMPTY.
static Source	readFrom(PlanStreamInput in)
Location	source()
static Source	synthetic(String text)	Deprecated. Sources created by this can't be correctly deserialized.
String	text()
String	toString()
String	viewName()	Returns the name of the view this source came from, or null if it came from the original query.
Source	withViewName(String viewName)	Returns a new Source with the same location and text but associated with the given view name.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final Source EMPTY

Constructor Details

Source

public Source(int line,
 int charPositionInLine,
 String text)

Source

public Source(Location location,
 String text)

Source

public Source(Location location,
 String text,
 String viewName)

Method Details

withViewName

public Source withViewName(String viewName)

Returns a new Source with the same location and text but associated with the given view name. This is used during view resolution to tag Source objects with their origin view.

readFrom

public static Source readFrom(PlanStreamInput in)
                       throws IOException

Throws:

IOException

readEmpty

public static Source readEmpty(StreamInput in)
                        throws IOException

Read the components of a Source and throw it away, returning EMPTY. Use this when you will never use the Source and there is no chance of getting a PlanStreamInput.

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

source

public Location source()

text

public String text()

Specified by:

text in interface WarningSourceLocation

viewName

public String viewName()

Returns the name of the view this source came from, or null if it came from the original query.

Specified by:

viewName in interface WarningSourceLocation

lineNumber

public int lineNumber()

Specified by:

lineNumber in interface WarningSourceLocation

columnNumber

public int columnNumber()

Specified by:

columnNumber in interface WarningSourceLocation

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

synthetic

@Deprecated
public static Source synthetic(String text)

Deprecated.

Sources created by this can't be correctly deserialized. For use in tests only.