Class

com.salesforce.op.stages.impl.feature

FilterMap

Related Doc: package feature

Permalink

class FilterMap[I <: OPMap[_]] extends UnaryTransformer[I, I] with MapPivotParams with TextParams with CleanTextMapFun

Filters maps by keys provided in a whiteList or blackList

I

input feature type

Linear Supertypes
CleanTextMapFun, CleanTextFun, TextParams, MapPivotParams, UnaryTransformer[I, I], OpTransformer1[I, I], OpTransformer, OpPipelineStage1[I, I], HasIn1, OpPipelineStage[I], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FilterMap
  2. CleanTextMapFun
  3. CleanTextFun
  4. TextParams
  5. MapPivotParams
  6. UnaryTransformer
  7. OpTransformer1
  8. OpTransformer
  9. OpPipelineStage1
  10. HasIn1
  11. OpPipelineStage
  12. OpPipelineStageBase
  13. MLWritable
  14. OpPipelineStageParams
  15. InputParams
  16. Transformer
  17. PipelineStage
  18. Logging
  19. Params
  20. Serializable
  21. Serializable
  22. Identifiable
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FilterMap(uid: String = UID[FilterMap[_]])(implicit tti: scala.reflect.api.JavaUniverse.TypeTag[I])

    Permalink

    uid

    uid for instance

    tti

    type tag for input

Type Members

  1. final type InputFeatures = FeatureLike[I]

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage1OpPipelineStageInputParams
  2. type KeyValue = (String) ⇒ Any

    Permalink

    Feature name (key) -> value lookup, e.g Row, Map etc.

    Feature name (key) -> value lookup, e.g Row, Map etc.

    Definition Classes
    OpTransformer
  3. final type OutputFeatures = FeatureLike[I]

    Permalink
    Definition Classes
    OpPipelineStageOpPipelineStageBase

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 $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. final val blackListKeys: StringArrayParam

    Permalink
    Definition Classes
    MapPivotParams
  7. final def checkInputLength(features: Array[_]): Boolean

    Permalink

    Checks the input length

    Checks the input length

    features

    input features

    returns

    true is input size as expected, false otherwise

    Definition Classes
    OpPipelineStage1InputParams
  8. final def checkSerializable: Try[Unit]

    Permalink

    Check if the stage is serializable

    Check if the stage is serializable

    returns

    Failure if not serializable

    Definition Classes
    OpTransformer1OpPipelineStageBase
  9. final val cleanKeys: BooleanParam

    Permalink
    Definition Classes
    MapPivotParams
  10. def cleanMap[V](m: Map[String, V], shouldCleanKey: Boolean, shouldCleanValue: Boolean): Map[String, V]

    Permalink
    Definition Classes
    CleanTextMapFun
  11. final val cleanText: BooleanParam

    Permalink
    Definition Classes
    TextParams
  12. def cleanTextFn(s: String, shouldClean: Boolean): String

    Permalink
    Definition Classes
    CleanTextFun
  13. final def clear(param: Param[_]): FilterMap.this.type

    Permalink
    Definition Classes
    Params
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. final def copy(extra: ParamMap): FilterMap.this.type

    Permalink

    This method is used to make a copy of the instance with new parameters in several methods in spark internals Default will find the constructor and make a copy for any class (AS LONG AS ALL CONSTRUCTOR PARAMS ARE VALS, this is why type tags are written as implicit vals in base classes).

    This method is used to make a copy of the instance with new parameters in several methods in spark internals Default will find the constructor and make a copy for any class (AS LONG AS ALL CONSTRUCTOR PARAMS ARE VALS, this is why type tags are written as implicit vals in base classes).

    Note: that the convention in spark is to have the uid be a constructor argument, so that copies will share a uid with the original (developers should follow this convention).

    extra

    new parameters want to add to instance

    returns

    a new instance with the same uid

    Definition Classes
    OpPipelineStageBase → Params
  16. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  17. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  18. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  21. def explainParams(): String

    Permalink
    Definition Classes
    Params
  22. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  23. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  24. def filterKeys[V](m: Map[String, V], shouldCleanKey: Boolean, shouldCleanValue: Boolean): Map[String, V]

    Permalink
    Attributes
    protected
    Definition Classes
    MapPivotParams
  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  29. final def getInputFeature[T <: FeatureType](i: Int): Option[FeatureLike[T]]

    Permalink

    Gets an input feature Note: this method IS NOT safe to use outside the driver, please use getTransientFeature method instead

    Gets an input feature Note: this method IS NOT safe to use outside the driver, please use getTransientFeature method instead

    returns

    array of features

    Definition Classes
    InputParams
    Exceptions thrown

    NoSuchElementException if the features are not set

    RuntimeException in case one of the features is null

  30. final def getInputFeatures(): Array[OPFeature]

    Permalink

    Gets the input features Note: this method IS NOT safe to use outside the driver, please use getTransientFeatures method instead

    Gets the input features Note: this method IS NOT safe to use outside the driver, please use getTransientFeatures method instead

    returns

    array of features

    Definition Classes
    InputParams
    Exceptions thrown

    NoSuchElementException if the features are not set

    RuntimeException in case one of the features is null

  31. final def getInputSchema(): StructType

    Permalink
    Definition Classes
    OpPipelineStageParams
  32. final def getMetadata(): Metadata

    Permalink
    Definition Classes
    OpPipelineStageParams
  33. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  34. def getOutput(): FeatureLike[I]

    Permalink

    Output features that will be created by this stage

    Output features that will be created by this stage

    returns

    feature of type OutputFeatures

    Definition Classes
    OpPipelineStage1OpPipelineStageBase
  35. final def getOutputFeatureName: String

    Permalink

    Name of output feature (i.e.

    Name of output feature (i.e. column created by this stage)

    Definition Classes
    OpPipelineStage
  36. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  37. final def getTransientFeature(i: Int): Option[TransientFeature]

    Permalink

    Gets an input feature at index i

    Gets an input feature at index i

    i

    input index

    returns

    maybe an input feature

    Definition Classes
    InputParams
  38. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

    Definition Classes
    InputParams
  39. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  40. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  41. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  42. final def in1: TransientFeature

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1
  43. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  44. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. final def inputAsArray(in: InputFeatures): Array[OPFeature]

    Permalink

    Function to convert InputFeatures to an Array of FeatureLike

    Function to convert InputFeatures to an Array of FeatureLike

    returns

    an Array of FeatureLike

    Definition Classes
    OpPipelineStage1InputParams
  46. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  47. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  48. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  49. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  50. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  52. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  53. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  65. def onGetMetadata(): Unit

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

    Attributes
    protected
    Definition Classes
    OpPipelineStageParams
  66. def onSetInput(): Unit

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    OpPipelineStageBase
  67. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    UnaryTransformerOpPipelineStageBase
  68. final def outputAsArray(out: OutputFeatures): Array[OPFeature]

    Permalink

    Function to convert OutputFeatures to an Array of FeatureLike

    Function to convert OutputFeatures to an Array of FeatureLike

    returns

    an Array of FeatureLike

    Definition Classes
    OpPipelineStageOpPipelineStageBase
  69. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStage1OpPipelineStage
  70. def outputIsResponse: Boolean

    Permalink

    Should output feature be a response? Yes, if any of the input features are.

    Should output feature be a response? Yes, if any of the input features are.

    returns

    true if the the output feature should be a response

    Definition Classes
    OpPipelineStage
  71. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  72. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  73. final def set(paramPair: ParamPair[_]): FilterMap.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  74. final def set(param: String, value: Any): FilterMap.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  75. final def set[T](param: Param[T], value: T): FilterMap.this.type

    Permalink
    Definition Classes
    Params
  76. final def setBlackListKeys(keys: Array[String]): FilterMap.this.type

    Permalink
    Definition Classes
    MapPivotParams
  77. def setCleanKeys(clean: Boolean): FilterMap.this.type

    Permalink
    Definition Classes
    MapPivotParams
  78. def setCleanText(clean: Boolean): FilterMap.this.type

    Permalink
    Definition Classes
    TextParams
  79. final def setDefault(paramPairs: ParamPair[_]*): FilterMap.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  80. final def setDefault[T](param: Param[T], value: T): FilterMap.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  81. final def setInput(features: InputFeatures): FilterMap.this.type

    Permalink

    Input features that will be used by the stage

    Input features that will be used by the stage

    returns

    feature of type InputFeatures

    Definition Classes
    OpPipelineStageBase
  82. final def setInputFeatures[S <: OPFeature](features: Array[S]): FilterMap.this.type

    Permalink

    Sets input features

    Sets input features

    S

    feature like type

    features

    array of input features

    returns

    this stage

    Attributes
    protected
    Definition Classes
    InputParams
  83. final def setMetadata(m: Metadata): FilterMap.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  84. def setOutputFeatureName(name: String): FilterMap.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  85. final def setWhiteListKeys(keys: Array[String]): FilterMap.this.type

    Permalink
    Definition Classes
    MapPivotParams
  86. final def stageName: String

    Permalink

    Stage unique name consisting of the stage operation name and uid

    Stage unique name consisting of the stage operation name and uid

    returns

    stage name

    Definition Classes
    OpPipelineStageBase
  87. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  88. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  89. def transform(dataset: Dataset[_]): DataFrame

    Permalink

    Spark operation on dataset to produce new output feature column using defined function

    Spark operation on dataset to produce new output feature column using defined function

    dataset

    input data for this stage

    returns

    a new dataset containing a column for the transformed feature

    Definition Classes
    OpTransformer1 → Transformer
  90. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  91. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  92. def transformFn: (I) ⇒ I

    Permalink

    Function used to convert input to output

    Function used to convert input to output

    Definition Classes
    FilterMapOpTransformer1
  93. lazy val transformKeyValue: (KeyValue) ⇒ Any

    Permalink

    Creates a transform function to transform any key/value to a value

    Creates a transform function to transform any key/value to a value

    returns

    a transform function to transform any key/value to a value

    Definition Classes
    OpTransformer1 → OpTransformer
  94. def transformMap: (Map[String, Any]) ⇒ Any

    Permalink

    Creates a transform function to transform Map to a value

    Creates a transform function to transform Map to a value

    returns

    a transform function to transform Map to a value

    Definition Classes
    OpTransformer
  95. def transformRow: (Row) ⇒ Any

    Permalink

    Creates a transform function to transform Row to a value

    Creates a transform function to transform Row to a value

    returns

    a transform function to transform Row to a value

    Definition Classes
    OpTransformer
  96. final def transformSchema(schema: StructType): StructType

    Permalink

    This function translates the input and output features into spark schema checks and changes that will occur on the underlying data frame

    This function translates the input and output features into spark schema checks and changes that will occur on the underlying data frame

    schema

    schema of the input data frame

    returns

    a new schema with the output features added

    Definition Classes
    OpPipelineStageBase
  97. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  98. implicit val tti: scala.reflect.api.JavaUniverse.TypeTag[I]

    Permalink

    type tag for input

    type tag for input

    Definition Classes
    UnaryTransformerOpTransformer1
  99. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[I]

    Permalink

    type tag for output

    type tag for output

    Definition Classes
    UnaryTransformerOpPipelineStage1
  100. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[I.Value]

    Permalink

    type tag for output value

    type tag for output value

    Definition Classes
    UnaryTransformerOpPipelineStage1
  101. val uid: String

    Permalink

    uid for instance

    uid for instance

    Definition Classes
    UnaryTransformer → Identifiable
  102. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  105. final val whiteListKeys: StringArrayParam

    Permalink
    Definition Classes
    MapPivotParams
  106. final def write: MLWriter

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from CleanTextMapFun

Inherited from CleanTextFun

Inherited from TextParams

Inherited from MapPivotParams

Inherited from UnaryTransformer[I, I]

Inherited from OpTransformer1[I, I]

Inherited from OpTransformer

Inherited from OpPipelineStage1[I, I]

Inherited from HasIn1

Inherited from OpPipelineStage[I]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped