Package com.c12e.cortex.profiles.featurecatalog

Class FeatureReport

  • public class FeatureReport
extends java.lang.Object
    POJO holding inferred feature information, a reference to the Dataset (sample) it was inferred from, and a separate preview of the Dataset. The Dataset preview needn't match the Dataset (sample).

    • Constructor Summary

      Constructors 
      Constructor Description
      FeatureReport​(java.util.List<com.c12e.cortex.phoenix.Feature> features, org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> df, java.util.List<org.apache.spark.sql.Row> previewCollection)
      Creates a FeatureReport.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getDf()
      Dataset the features were inferred from
      java.util.List<com.c12e.cortex.phoenix.Feature> getFeatures()
      Returns the list of features
      java.util.List<org.apache.spark.sql.Row> getPreviewCollection()
      Explicit preview of the Dataset

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FeatureReport

        public FeatureReport​(java.util.List<com.c12e.cortex.phoenix.Feature> features,
                     org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> df,
                     java.util.List<org.apache.spark.sql.Row> previewCollection)
        Creates a FeatureReport.
        Parameters:
        features - features in the data sample
        df - dataset features were inferred from
        previewCollection - Preview of the Collection

    • Method Detail

      • getFeatures

        public java.util.List<com.c12e.cortex.phoenix.Feature> getFeatures()
        Returns the list of features
        Returns:
        inferred features

      • getDf

        public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getDf()
        Dataset the features were inferred from
        Returns:
        Spark Dataset

      • getPreviewCollection

        public java.util.List<org.apache.spark.sql.Row> getPreviewCollection()
        Explicit preview of the Dataset
        Returns:
        list of Dataset rows