Class

com.salesforce.op.stages.impl.feature

ParsePhoneNumber

Related Doc: package feature

Permalink

class ParsePhoneNumber extends BinaryTransformer[Phone, Text, Phone] with PhoneCountryParams

Determine whether a phone number is valid given the country's regional code. By default the regional code will be checked against those provided in Google's PhoneNumber library. If the input regional code is not found, the default locale will be used for validation.

If the User provided a Country name to code mapping, the phone number can only be validated against the input mapping. This transformer will first match on regional code, failing that, it will select the country with the closest Q-Distance.

All phone numbers with less than 2 characters will be categorized as invalid

All phone numbers that starts with "+" will be evaluated with international formatting

Returns stripped number if number is valid. And None other wise.

Linear Supertypes
PhoneCountryParams, PhoneParams, BinaryTransformer[Phone, Text, Phone], OpTransformer2[Phone, Text, Phone], OpTransformer, OpPipelineStage2[Phone, Text, Phone], HasIn2, HasIn1, OpPipelineStage[Phone], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParsePhoneNumber
  2. PhoneCountryParams
  3. PhoneParams
  4. BinaryTransformer
  5. OpTransformer2
  6. OpTransformer
  7. OpPipelineStage2
  8. HasIn2
  9. HasIn1
  10. OpPipelineStage
  11. OpPipelineStageBase
  12. MLWritable
  13. OpPipelineStageParams
  14. InputParams
  15. Transformer
  16. PipelineStage
  17. Logging
  18. Params
  19. Serializable
  20. Serializable
  21. Identifiable
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ParsePhoneNumber(uid: String = UID[ParsePhoneNumber])

    Permalink

Type Members

  1. final type InputFeatures = (FeatureLike[Phone], FeatureLike[Text])

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage2OpPipelineStageInputParams
  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[Phone]

    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 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
    OpPipelineStage2InputParams
  7. 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
    OpTransformer2OpPipelineStageBase
  8. final def clear(param: Param[_]): ParsePhoneNumber.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def copy(extra: ParamMap): ParsePhoneNumber.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
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  12. final val countryNames: StringArrayParam

    Permalink
    Definition Classes
    PhoneCountryParams
  13. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. final val defaultRegion: Param[String]

    Permalink
    Definition Classes
    PhoneParams
  15. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  21. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  25. 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

  26. 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

  27. final def getInputSchema(): StructType

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

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

    Permalink
    Definition Classes
    Params
  30. def getOutput(): FeatureLike[Phone]

    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
    OpPipelineStage2OpPipelineStageBase
  31. 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
  32. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  33. 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
  34. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1
  39. final def in2: TransientFeature

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn2
  40. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  42. 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
    OpPipelineStage2InputParams
  43. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

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

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    OpPipelineStageBase
  64. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    BinaryTransformerOpPipelineStageBase
  65. 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
  66. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStage2OpPipelineStage
  67. 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
  68. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  69. final val regionCodes: StringArrayParam

    Permalink
    Definition Classes
    PhoneCountryParams
  70. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  74. def setCodesAndCountries(countryCodes: Map[String, String]): ParsePhoneNumber.this.type

    Permalink

    Initialize with country name and their codes.

    Initialize with country name and their codes. The strings are upper cased when set.

    By default this transformer will validate against the regional codes provided by Google's PhoneNumber library.

    If the user would like to use country names as the second argument to this transformer, a mapping between the names and their code must be provided here.

    countryCodes

    country Code -> country Name eg "US" -> "United States of America"

    returns

    reference to self

    Definition Classes
    PhoneCountryParams
  75. final def setDefault(paramPairs: ParamPair[_]*): ParsePhoneNumber.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  77. def setDefaultRegion(cc: String): ParsePhoneNumber.this.type

    Permalink

    Sets the default country code to use when a valid code cannot be determined

    Sets the default country code to use when a valid code cannot be determined

    cc

    Country code to check phone number validity against by default

    Definition Classes
    PhoneParams
  78. final def setInput(features: InputFeatures): ParsePhoneNumber.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
  79. final def setInputFeatures[S <: OPFeature](features: Array[S]): ParsePhoneNumber.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
  80. final def setMetadata(m: Metadata): ParsePhoneNumber.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  81. def setOutputFeatureName(name: String): ParsePhoneNumber.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  82. def setStrictness(flag: Boolean): ParsePhoneNumber.this.type

    Permalink

    If set to true, phone number will be compared strictly checked.

    If set to true, phone number will be compared strictly checked. If set to false, an input, that is too long, will be considered valid if a substring can be found to be valid

    Definition Classes
    PhoneParams
  83. 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
  84. final val strictValidation: BooleanParam

    Permalink
    Definition Classes
    PhoneParams
  85. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  87. 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
    OpTransformer2 → Transformer
  88. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  90. def transformFn: (Phone, Text) ⇒ Phone

    Permalink

    Function used to convert input to output

    Function used to convert input to output

    Definition Classes
    ParsePhoneNumberOpTransformer2
  91. 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
    OpTransformer2 → OpTransformer
  92. 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
  93. 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
  94. 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
  95. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  96. implicit val tti1: scala.reflect.api.JavaUniverse.TypeTag[Phone]

    Permalink

    type tag for first input

    type tag for first input

    Definition Classes
    BinaryTransformerOpTransformer2
  97. implicit val tti2: scala.reflect.api.JavaUniverse.TypeTag[Text]

    Permalink

    type tag for second input

    type tag for second input

    Definition Classes
    BinaryTransformerOpTransformer2
  98. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[Phone]

    Permalink

    type tag for output

    type tag for output

    Definition Classes
    BinaryTransformerOpPipelineStage2
  99. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[features.types.Phone.Value]

    Permalink

    type tag for output value

    type tag for output value

    Definition Classes
    BinaryTransformerOpPipelineStage2
  100. val uid: String

    Permalink

    uid for instance

    uid for instance

    Definition Classes
    BinaryTransformer → Identifiable
  101. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  104. final def write: MLWriter

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from PhoneCountryParams

Inherited from PhoneParams

Inherited from BinaryTransformer[Phone, Text, Phone]

Inherited from OpTransformer2[Phone, Text, Phone]

Inherited from OpTransformer

Inherited from OpPipelineStage2[Phone, Text, Phone]

Inherited from HasIn2

Inherited from HasIn1

Inherited from OpPipelineStage[Phone]

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