Package com.atlan.model.fields

Class InternalKeywordField

java.lang.Object

com.atlan.model.fields.AtlanField

com.atlan.model.fields.SearchableField

com.atlan.model.fields.KeywordField

com.atlan.model.fields.InternalKeywordField

All Implemented Interfaces:

IInternalSearchable, IKeywordSearchable, ISearchable

public class InternalKeywordField
extends KeywordField
implements IInternalSearchable

Represents any field in Atlan that can be searched only by keyword (no text-analyzed fuzziness), and can also be searched against a special internal field directly within Atlan.

Field Summary

Fields inherited from class com.atlan.model.fields.KeywordField

inLineage

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

EMBEDDED_SOURCE_VALUE

Constructor Summary

Constructors

Constructor	Description
InternalKeywordField(String atlan, String internal, String keyword)	Default constructor.

Method Summary

Modifier and Type	Method	Description
String	getInternalFieldName()	Returns the name of the internal field for this attribute in Atlan.

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

eq, eq, getKeywordFieldName, in, in, regex, startsWith, wildcard

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.IKeywordSearchable

eq, regex, regex, startsWith, wildcard

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

bucketBy, bucketBy

Constructor Details

InternalKeywordField

public InternalKeywordField(String atlan,
 String internal,
 String keyword)

Default constructor.

Parameters:

atlan - name of the attribute in the metastore

internal - name of the internal searchable attribute in the metastore

keyword - name of the keyword field in the search index

Method Details

getInternalFieldName

public String getInternalFieldName()

Description copied from interface: IInternalSearchable

Returns the name of the internal field for this attribute in Atlan.

Specified by:

getInternalFieldName in interface IInternalSearchable

Returns:

the field name for the internal (searchable) field in Atlan for this attribute