Class/Object

org.tresamigos.smv

SmvExtModulePython

Related Docs: object SmvExtModulePython | package smv

Permalink

class SmvExtModulePython extends SmvDataSet with InterfacesWithPy4J

Concrete SmvDataSet representation of modules defined in Python. Created exclusively by DataSetRepoPython. Wraps an ISmvModule.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SmvExtModulePython
  2. InterfacesWithPy4J
  3. SmvDataSet
  4. FilenamePart
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SmvExtModulePython(target: ISmvModule)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def allDeps: Seq[SmvDataSet]

    Permalink

    All dependencies with the dependency hierarchy flattened

    All dependencies with the dependency hierarchy flattened

    Definition Classes
    SmvDataSet
  5. lazy val ancestors: Seq[SmvDataSet]

    Permalink
    Definition Classes
    SmvDataSet
  6. def app: SmvApp

    Permalink
    Definition Classes
    SmvDataSet
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def datasetHash(): Int

    Permalink

    Hash computed from the dataset, could be overridden to include things other than CRC

    Hash computed from the dataset, could be overridden to include things other than CRC

    Definition Classes
    SmvDataSet
  10. val description: String

    Permalink
    Definition Classes
    SmvExtModulePythonSmvDataSet
  11. def dqm(): SmvDQM

    Permalink

    Define the DQM rules, fixes and policies to be applied to this DataSet.

    Define the DQM rules, fixes and policies to be applied to this DataSet. See org.tresamigos.smv.dqm, org.tresamigos.smv.dqm.DQMRule, and org.tresamigos.smv.dqm.DQMFix for details on creating rules and fixes.

    Concrete modules and files should override this method to define rules/fixes to apply. The default is to provide an empty set of DQM rules/fixes.

    Definition Classes
    SmvExtModulePythonSmvDataSet
  12. def dsType(): String

    Permalink

    DataSet type: could be 4 values, Input, Link, Module, Output

    DataSet type: could be 4 values, Input, Link, Module, Output

    Definition Classes
    SmvExtModulePythonSmvDataSet
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def exportToHive(collector: SmvRunInfoCollector): Serializable

    Permalink

    Exports a dataframe to a hive table.

    Exports a dataframe to a hive table.

    Definition Classes
    SmvDataSet
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def fnpart: String

    Permalink

    Names the persisted file for the result of this SmvDataSet

    Names the persisted file for the result of this SmvDataSet

    Definition Classes
    SmvDataSetFilenamePart
  18. val fqn: String

    Permalink

    The FQN of an SmvDataSet is its classname for Scala implementations.

    The FQN of an SmvDataSet is its classname for Scala implementations.

    Scala proxies for implementations in other languages must override this to name the proxied FQN.

    Definition Classes
    SmvExtModulePythonSmvDataSet
  19. def getAncillary[T <: SmvAncillary](anc: T): T

    Permalink

    TODO: remove this method as checkDependency replaced this function

    TODO: remove this method as checkDependency replaced this function

    Definition Classes
    SmvDataSet
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def getPy4JResult[T](response: IPythonResponsePy4J[T]): T

    Permalink
    Definition Classes
    InterfacesWithPy4J
  22. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  23. def instanceValHash(): Int

    Permalink

    Hash computed based on instance values of the dataset, such as the timestamp of an input file *

    Hash computed based on instance values of the dataset, such as the timestamp of an input file *

    Definition Classes
    SmvExtModulePythonSmvDataSet
  24. def isEphemeral: Boolean

    Permalink

    flag if this module is ephemeral or short lived so that it will not be persisted when a graph is executed.

    flag if this module is ephemeral or short lived so that it will not be persisted when a graph is executed. This is quite handy for "filter" or "map" type modules so that we don't force an extra I/O step when it is not needed. By default all modules are persisted unless the flag is overridden to true. Note: the module will still be persisted if it was specifically selected to run by the user.

    Definition Classes
    SmvExtModulePythonSmvDataSet
  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. val isObjectInShell: Boolean

    Permalink

    Objects defined in Spark Shell has class name start with $ *

    Objects defined in Spark Shell has class name start with $ *

    Definition Classes
    SmvDataSet
  27. def metadata(df: DataFrame): SmvMetadata

    Permalink

    Can be overridden to supply custom metadata TODO: make SmvMetadata more user friendly or find alternative format for user metadata

    Can be overridden to supply custom metadata TODO: make SmvMetadata more user friendly or find alternative format for user metadata

    Definition Classes
    SmvExtModulePythonSmvDataSet
  28. def metadataHistorySize(): Integer

    Permalink

    Maximum of the metadata history TODO: Verify that this is positive

    Maximum of the metadata history TODO: Verify that this is positive

    Definition Classes
    SmvExtModulePythonSmvDataSet
  29. def moduleCsvPath(prefix: String = ""): String

    Permalink

    Returns the path for the module's csv output

    Returns the path for the module's csv output

    Definition Classes
    SmvDataSet
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. def persist(dataframe: DataFrame, prefix: String = ""): Unit

    Permalink
    Definition Classes
    SmvDataSet
  34. def publishHiveSql: Option[String]

    Permalink

    An optional sql query to run to publish the results of this module when the --publish-hive command line is used.

    An optional sql query to run to publish the results of this module when the --publish-hive command line is used. The DataFrame result of running this module will be available to the query as the "dftable" table. For example: return "insert overwrite table mytable select * from dftable" If this method is not specified, the default is to just create the table specified by tableName() with the results of the module.

    Definition Classes
    SmvExtModulePythonSmvDataSet
  35. def rdd(forceRun: Boolean = false, genEdd: Boolean = app.genEdd, collector: SmvRunInfoCollector): DataFrame

    Permalink

    returns the DataFrame from this dataset (file/module).

    returns the DataFrame from this dataset (file/module). The value is cached so this function can be called repeatedly. The cache is external to SmvDataSet so that it we will not recalculate the DF even after dynamically loading the same SmvDataSet. If force argument is true, the we skip the cache. Note: the RDD graph is cached and NOT the data (i.e. rdd.cache is NOT called here)

    Definition Classes
    SmvDataSet
  36. def readFile(path: String, attr: CsvAttributes = CsvAttributes.defaultCsv): DataFrame

    Permalink

    Read a dataframe from a persisted file path, that is usually an input data set or the output of an upstream SmvModule.

    Read a dataframe from a persisted file path, that is usually an input data set or the output of an upstream SmvModule.

    The default format is headerless CSV with '"' as the quote character

    Definition Classes
    SmvDataSet
  37. def requiresAnc(): Seq[SmvAncillary]

    Permalink
    Definition Classes
    SmvDataSet
  38. def requiresDS(): Nothing

    Permalink

    modules must override to provide set of datasets they depend on.

    modules must override to provide set of datasets they depend on. This is no longer the canonical list of dependencies. Internally we should query resolvedRequiresDS for dependencies.

    Definition Classes
    SmvExtModulePythonSmvDataSet
  39. def resolve(resolver: DataSetResolver): SmvDataSet

    Permalink
    Definition Classes
    SmvExtModulePythonSmvDataSet
  40. var resolvedRequiresDS: Seq[SmvDataSet]

    Permalink

    fixed list of SmvDataSet dependencies

    fixed list of SmvDataSet dependencies

    Definition Classes
    SmvDataSet
  41. def runInfo: SmvRunInfo

    Permalink

    Returns the run information from this dataset's last run.

    Returns the run information from this dataset's last run.

    If the dataset has never been run, returns an empty run info with null for its components.

    Definition Classes
    SmvDataSet
  42. def setTimestamp(dt: DateTime): Unit

    Permalink
    Definition Classes
    SmvDataSet
  43. def sourceCodeHash(): Int

    Permalink

    Hash computed based on the source code of the dataset's class *

    Hash computed based on the source code of the dataset's class *

    Definition Classes
    SmvExtModulePythonSmvDataSet
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  45. def tableName: String

    Permalink

    full name of hive output table if this module is published to hive.

    full name of hive output table if this module is published to hive.

    Definition Classes
    SmvExtModulePythonSmvDataSet
  46. def toString(): String

    Permalink
    Definition Classes
    SmvDataSet → AnyRef → Any
  47. def urn: URN

    Permalink
    Definition Classes
    SmvDataSet
  48. def validateMetadata(current: SmvMetadata, history: Seq[SmvMetadata]): Option[String]

    Permalink

    Override to validate module results based on current and historic metadata.

    Override to validate module results based on current and historic metadata. If Some, DQM will fail. Defaults to None.

    Definition Classes
    SmvExtModulePythonSmvDataSet
  49. def verHex: String

    Permalink
    Definition Classes
    SmvDataSet
  50. def version(): Int

    Permalink

    user tagged code "version".

    user tagged code "version". Derived classes should update the value when code or data

    Definition Classes
    SmvDataSet
  51. def versionedFqn: String

    Permalink
    Definition Classes
    SmvDataSet
  52. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from InterfacesWithPy4J

Inherited from SmvDataSet

Inherited from FilenamePart

Inherited from AnyRef

Inherited from Any

Ungrouped