org.apache.nifi.provenance.search

Interface SearchableField

public interface SearchableField

A SearchableField represents a field in a Provenance Event that can be searched

Method Summary

Methods

Modifier and Type	Method and Description
SearchableFieldType	getFieldType()
String	getFriendlyName()
String	getIdentifier()
String	getSearchableFieldName()
boolean	isAttribute()

Method Detail

getIdentifier

String getIdentifier()

Returns:

the identifier that is used to refer to this field

getSearchableFieldName

String getSearchableFieldName()

Returns:

the name of the field that is used when searching the repository

getFriendlyName

String getFriendlyName()

Returns:

the "friendly" name or "display name" of the field, which may be more human-readable than the searchable field name

getFieldType

SearchableFieldType getFieldType()

Returns:

the type of the data stored in this field

isAttribute

boolean isAttribute()

Returns:

true if this field represents a FlowFile attribute, false if the field represents a Provenance Event detail, such as Source System URI