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

Class TypedAttribute

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.NamedExpression

org.elasticsearch.xpack.esql.core.expression.Attribute

org.elasticsearch.xpack.esql.core.expression.TypedAttribute

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

Direct Known Subclasses:

ExternalMetadataAttribute, FieldAttribute, MetadataAttribute, ReferenceAttribute, TemporalityAttribute

public abstract class TypedAttribute
extends Attribute

A fully resolved attribute - we know its type. For example, if it references data directly from Lucene, this will be a FieldAttribute. If it references the results of another calculation it will be ReferenceAttributes.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Attribute

Attribute.IdIgnoringWrapper

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

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

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

Field Summary

Fields inherited from class org.elasticsearch.xpack.esql.core.expression.Attribute

SYNTHETIC_ATTRIBUTE_NAME_PREFIX, SYNTHETIC_ATTRIBUTE_NAME_SEPARATOR

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TypedAttribute(Source source, String qualifier, String name, DataType dataType, Nullability nullability, NameId id, boolean synthetic)
protected	TypedAttribute(Source source, String name, DataType dataType, Nullability nullability, NameId id, boolean synthetic)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
protected boolean	innerEquals(Object o, boolean ignoreIds)	The actual equality check, after shortcutting this == o and class checks.
protected int	innerHashCode(boolean ignoreIds)

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Attribute

canonicalize, checkAndSerializeQualifier, clone, dataTypeEquals, ignoreId, isDimension, isMetric, label, nodeString, nullable, qualifiedName, qualifier, rawTemporaryName, readQualifier, references, replaceChildren, semanticEquals, semanticHash, toAttribute, toString, withDataType, withId, withLocation, withName, withNullability, withQualifier

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.NamedExpression

equals, equals, hashCode, hashCode, id, name, synthetic

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, childrenResolved, fold, foldable, propertiesToString, resolved, resolveType, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, info, nodeName, nodeProperties, nodeString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, transformDownSkipBranch, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Constructor Details

TypedAttribute

protected TypedAttribute(Source source,
 String name,
 DataType dataType,
 Nullability nullability,
 @Nullable
 NameId id,
 boolean synthetic)

TypedAttribute

protected TypedAttribute(Source source,
 @Nullable
 String qualifier,
 String name,
 DataType dataType,
 Nullability nullability,
 @Nullable
 NameId id,
 boolean synthetic)

Method Details

dataType

public DataType dataType()

Description copied from class: Expression

The DataType returned by executing the tree rooted at this expression. If Expression.typeResolved() returns an error then the behavior of this method is undefined. It may return a valid type. Or it may throw an exception. Or it may return a totally nonsensical type.

Specified by:

dataType in class Expression

innerHashCode

protected int innerHashCode(boolean ignoreIds)

Overrides:

innerHashCode in class Attribute

innerEquals

protected boolean innerEquals(Object o,
 boolean ignoreIds)

Description copied from class: NamedExpression

The actual equality check, after shortcutting this == o and class checks.

Overrides:

innerEquals in class Attribute