Package com.atlan.model.fields

Class TextField

java.lang.Object

com.atlan.model.fields.AtlanField

com.atlan.model.fields.SearchableField

com.atlan.model.fields.TextField

All Implemented Interfaces:

ISearchable, ITextSearchable

public class TextField
extends SearchableField
implements ITextSearchable

Represents any field in Atlan that can only be searched using text-related search operations.

Field Summary

Fields

Modifier and Type	Field	Description
final LineageFilterFieldString	inLineage

Fields inherited from interface com.atlan.model.fields.ISearchable

EMBEDDED_SOURCE_VALUE

Constructor Summary

Constructors

Constructor	Description
TextField(String atlan, String text)	Default constructor.

Method Summary

Modifier and Type	Method	Description
String	getTextFieldName()	Returns the name of the text field index for this attribute in Elastic.
co.elastic.clients.elasticsearch._types.query_dsl.Query	match(String value)	Returns a query that will textually match the provided value against the field.

Methods inherited from class com.atlan.model.fields.SearchableField

bucketBy, bucketBy, count, distinct, distinct, getElasticFieldName, hasAnyValue, order

Methods inherited from class com.atlan.model.fields.AtlanField

getAtlanFieldName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlan.model.fields.ISearchable

bucketBy, bucketBy

Field Details

inLineage

public final LineageFilterFieldString inLineage

Constructor Details

TextField

public TextField(String atlan,
 String text)

Default constructor.

Parameters:

atlan - name of the attribute in the metastore

text - name of the text field in the search index

Method Details

getTextFieldName

public String getTextFieldName()

Returns the name of the text field index for this attribute in Elastic.

Specified by:

getTextFieldName in interface ITextSearchable

Returns:

the field name for the text index on this attribute

match

public co.elastic.clients.elasticsearch._types.query_dsl.Query match(String value)

Returns a query that will textually match the provided value against the field. This analyzes the provided value according to the same analysis carried out on the field (for example, tokenization, stemming, and so on).

Specified by:

match in interface ITextSearchable

Parameters:

value - the string value to match against

Returns:

a query that will only match assets whose analyzed value for the field matches the value provided (which will also be analyzed)