com.logicalclocks.hsfs.metadata

Class FeatureGroupBase

java.lang.Object

com.logicalclocks.hsfs.metadata.FeatureGroupBase

Direct Known Subclasses:

ExternalFeatureGroup, FeatureGroup, StreamFeatureGroup

public class FeatureGroupBase
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	created
protected User	creator
protected String	description
protected String	eventTime
protected List<String>	expectationsNames
protected FeatureGroupBaseEngine	featureGroupBaseEngine
protected List<Feature>	features
protected FeatureStore	featureStore
protected Integer	id
protected String	location
protected String	name
protected List<String>	primaryKeys
protected StatisticsConfig	statisticsConfig
protected StatisticsEngine	statisticsEngine
protected Subject	subject
protected TimeTravelFormat	timeTravelFormat
protected String	type
protected FeatureGroupUtils	utils
protected Integer	version

Constructor Summary

Constructors

Constructor and Description
FeatureGroupBase()
FeatureGroupBase(FeatureStore featureStore, Integer id)

Method Summary

Modifier and Type	Method and Description
void	addTag(String name, Object value) Add name/value tag to the feature group.
void	appendFeatures(Feature features) Append a single feature to the schema of the feature group.
void	appendFeatures(List<Feature> features) Append features to the schema of the feature group.
Statistics	computeStatistics() Recompute the statistics for the feature group and save them to the feature store.
void	delete()
void	deleteTag(String name) Delete a tag of the feature group.
Query	filter(Filter filter) Filter the query based on a condition for a feature or a conjunction of multiple filters.
Query	filter(FilterLogic filter) Filter the query based on a condition for a feature or a conjunction of multiple filters.
List<String>	getComplexFeatures()
Date	getCreated()
User	getCreator()
String	getDescription()
org.apache.avro.Schema	getDeserializedAvroSchema()
String	getEncodedAvroSchema()
String	getEventTime()
List<String>	getExpectationsNames()
Feature	getFeature(String name) Retrieve a feature of the feature group by name.
String	getFeatureAvroSchema(String featureName)
List<Feature>	getFeatures()
FeatureStore	getFeatureStore()
Integer	getId()
String	getLocation()
String	getName()
String	getOnlineTopicName()
List<String>	getPrimaryKeys()
Statistics	getStatistics() Get the last statistics commit for the feature group.
Statistics	getStatistics(String commitTime) Get the statistics of a specific commit time for the feature group.
StatisticsConfig	getStatisticsConfig()
Subject	getSubject()
Object	getTag(String name) Get a single tag value of the feature group.
Map<String,Object>	getTags() Get all tags of the feature group.
TimeTravelFormat	getTimeTravelFormat()
String	getType()
Integer	getVersion()
<T> T	read()
Query	select(List<String> features)
Query	selectAll()
Query	selectAll(boolean includePrimaryKey, boolean includeEventTime)
Query	selectExcept(List<String> features)
Query	selectExceptFeatures(List<Feature> features)
Query	selectFeatures(List<Feature> features)
void	setDescription(String description)
void	setEventTime(String eventTime)
void	setExpectationsNames(List<String> expectationsNames)
void	setFeatures(List<Feature> features)
void	setFeatureStore(FeatureStore featureStore)
void	setId(Integer id)
void	setLocation(String location)
void	setName(String name)
void	setStatisticsConfig(StatisticsConfig statisticsConfig)
void	setTimeTravelFormat(TimeTravelFormat timeTravelFormat)
void	setType(String type)
void	setVersion(Integer version)
void	unloadSubject()
void	updateDescription(String description) Update the description of the feature group.
void	updateFeatureDescription(String featureName, String description) Update the description of a single feature.
void	updateFeatures(Feature feature) Update the metadata of multiple features.
void	updateFeatures(List<Feature> features) Update the metadata of multiple features.
void	updateStatisticsConfig() Update the statistics configuration of the feature group.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Integer id

featureStore

protected FeatureStore featureStore

type

protected String type

name

protected String name

version

protected Integer version

description

protected String description

primaryKeys

protected List<String> primaryKeys

features

protected List<Feature> features

eventTime

protected String eventTime

created

protected Date created

creator

protected User creator

statisticsConfig

protected StatisticsConfig statisticsConfig

expectationsNames

protected List<String> expectationsNames

location

protected String location

timeTravelFormat

protected TimeTravelFormat timeTravelFormat

subject

protected Subject subject

featureGroupBaseEngine

protected FeatureGroupBaseEngine featureGroupBaseEngine

statisticsEngine

protected StatisticsEngine statisticsEngine

utils

protected FeatureGroupUtils utils

Constructor Detail

FeatureGroupBase

public FeatureGroupBase(FeatureStore featureStore,
                        Integer id)

FeatureGroupBase

public FeatureGroupBase()

Method Detail

selectFeatures

public Query selectFeatures(List<Feature> features)

select

public Query select(List<String> features)

selectAll

public Query selectAll()

selectAll

public Query selectAll(boolean includePrimaryKey,
                       boolean includeEventTime)

selectExceptFeatures

public Query selectExceptFeatures(List<Feature> features)

selectExcept

public Query selectExcept(List<String> features)

delete

public void delete()
            throws FeatureStoreException,
                   IOException

Throws:

FeatureStoreException

IOException

read

public <T> T read()
           throws FeatureStoreException,
                  IOException

Throws:

FeatureStoreException

IOException

addTag

public void addTag(String name,
                   Object value)
            throws FeatureStoreException,
                   IOException

Add name/value tag to the feature group.

Parameters:

name - name of the tag

value - value of the tag. The value of a tag can be any valid json - primitives, arrays or json objects.

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getTags

public Map<String,Object> getTags()
                           throws FeatureStoreException,
                                  IOException

Get all tags of the feature group.

Returns:

map of tag name and values. The value of a tag can be any valid json - primitives, arrays or json objects

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getTag

public Object getTag(String name)
              throws FeatureStoreException,
                     IOException

Get a single tag value of the feature group.

Parameters:

name - name of tha tag

Returns:

The value of a tag can be any valid json - primitives, arrays or json objects

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

deleteTag

public void deleteTag(String name)
               throws FeatureStoreException,
                      IOException

Delete a tag of the feature group.

Parameters:

name - name of the tag to be deleted

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

updateDescription

public void updateDescription(String description)
                       throws FeatureStoreException,
                              IOException

Update the description of the feature group.

Parameters:

description - feature group description.

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

updateFeatureDescription

public void updateFeatureDescription(String featureName,
                                     String description)
                              throws FeatureStoreException,
                                     IOException

Update the description of a single feature.

Parameters:

featureName - Name of the feature

description - Description of the feature

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

updateFeatures

public void updateFeatures(List<Feature> features)
                    throws FeatureStoreException,
                           IOException,
                           ParseException

Update the metadata of multiple features. Currently only feature description updates are supported.

Parameters:

features - List of Feature metadata objects

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

ParseException - ParseException

updateFeatures

public void updateFeatures(Feature feature)
                    throws FeatureStoreException,
                           IOException,
                           ParseException

Update the metadata of multiple features. Currently only feature description updates are supported.

Parameters:

feature - Feature metadata object

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

ParseException - ParseException

appendFeatures

public void appendFeatures(List<Feature> features)
                    throws FeatureStoreException,
                           IOException,
                           ParseException

Append features to the schema of the feature group. It is only possible to append features to a feature group. Removing features is considered a breaking change.

Parameters:

features - list of Feature metadata objects

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

ParseException - ParseException

appendFeatures

public void appendFeatures(Feature features)
                    throws FeatureStoreException,
                           IOException,
                           ParseException

Append a single feature to the schema of the feature group. It is only possible to append features to a feature group. Removing features is considered a breaking change.

Parameters:

features - List of Feature metadata objects

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

ParseException - ParseException

updateStatisticsConfig

public void updateStatisticsConfig()
                            throws FeatureStoreException,
                                   IOException

Update the statistics configuration of the feature group. Change the `enabled`, `histograms`, `correlations` or `columns` attributes and persist the changes by calling this method.

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

computeStatistics

public Statistics computeStatistics()
                             throws FeatureStoreException,
                                    IOException

Recompute the statistics for the feature group and save them to the feature store.

Returns:

statistics object of computed statistics

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getStatistics

public Statistics getStatistics()
                         throws FeatureStoreException,
                                IOException

Get the last statistics commit for the feature group.

Returns:

statistics object of latest commit

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getStatistics

public Statistics getStatistics(String commitTime)
                         throws FeatureStoreException,
                                IOException

Get the statistics of a specific commit time for the feature group.

Parameters:

commitTime - commit time in the format "YYYYMMDDhhmmss"

Returns:

statistics object for the commit time

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getSubject

public Subject getSubject()
                   throws FeatureStoreException,
                          IOException

Throws:

FeatureStoreException

IOException

unloadSubject

public void unloadSubject()

filter

public Query filter(Filter filter)
             throws FeatureStoreException,
                    IOException

Filter the query based on a condition for a feature or a conjunction of multiple filters.

Parameters:

filter - Filter metadata object

Returns:

Query object

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

filter

public Query filter(FilterLogic filter)
             throws FeatureStoreException,
                    IOException

Filter the query based on a condition for a feature or a conjunction of multiple filters.

Parameters:

filter - Filter metadata object

Returns:

Query object

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getFeature

public Feature getFeature(String name)
                   throws FeatureStoreException

Retrieve a feature of the feature group by name.

Parameters:

name - feature name

Returns:

Feature metadata object

Throws:

FeatureStoreException - FeatureStoreException

getPrimaryKeys

public List<String> getPrimaryKeys()

getOnlineTopicName

public String getOnlineTopicName()
                          throws FeatureStoreException,
                                 IOException

Throws:

FeatureStoreException

IOException

getComplexFeatures

public List<String> getComplexFeatures()

getFeatureAvroSchema

public String getFeatureAvroSchema(String featureName)
                            throws FeatureStoreException,
                                   IOException

Throws:

FeatureStoreException

IOException

getEncodedAvroSchema

public String getEncodedAvroSchema()
                            throws FeatureStoreException,
                                   IOException

Throws:

FeatureStoreException

IOException

getDeserializedAvroSchema

public org.apache.avro.Schema getDeserializedAvroSchema()
                                                 throws FeatureStoreException,
                                                        IOException

Throws:

FeatureStoreException

IOException

getId

public Integer getId()

setId

public void setId(Integer id)

getFeatureStore

public FeatureStore getFeatureStore()

setFeatureStore

public void setFeatureStore(FeatureStore featureStore)

getType

public String getType()

setType

public void setType(String type)

getName

public String getName()

setName

public void setName(String name)

getVersion

public Integer getVersion()

setVersion

public void setVersion(Integer version)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getFeatures

public List<Feature> getFeatures()

setFeatures

public void setFeatures(List<Feature> features)

getEventTime

public String getEventTime()

setEventTime

public void setEventTime(String eventTime)

getCreated

public Date getCreated()

getCreator

public User getCreator()

getStatisticsConfig

public StatisticsConfig getStatisticsConfig()

setStatisticsConfig

public void setStatisticsConfig(StatisticsConfig statisticsConfig)

getExpectationsNames

public List<String> getExpectationsNames()

setExpectationsNames

public void setExpectationsNames(List<String> expectationsNames)

getLocation

public String getLocation()

setLocation

public void setLocation(String location)

getTimeTravelFormat

public TimeTravelFormat getTimeTravelFormat()

setTimeTravelFormat

public void setTimeTravelFormat(TimeTravelFormat timeTravelFormat)