org.apache.nifi.provenance.search

Interface SearchableField

All Known Implementing Classes:

NamedSearchableField

public interface SearchableField

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

Method Summary

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

Method Detail

getIdentifier

java.lang.String getIdentifier()

Returns:

the identifier that is used to refer to this field

getSearchableFieldName

java.lang.String getSearchableFieldName()

Returns:

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

getFriendlyName

java.lang.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