class ObfuscatorAnnotatorApproach extends AnnotatorApproach[ObfuscatorAnnotatorModel] with DeidApproachParams with ObfuscatorParams

Linear Supertypes
ObfuscatorParams, BaseDeidParams, DeidApproachParams, AnnotatorApproach[ObfuscatorAnnotatorModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[ObfuscatorAnnotatorModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ObfuscatorAnnotatorApproach
  2. ObfuscatorParams
  3. BaseDeidParams
  4. DeidApproachParams
  5. AnnotatorApproach
  6. CanBeLazy
  7. DefaultParamsWritable
  8. MLWritable
  9. HasOutputAnnotatorType
  10. HasOutputAnnotationCol
  11. HasInputAnnotationCols
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ObfuscatorAnnotatorApproach()
  2. new ObfuscatorAnnotatorApproach(uid: String)

Type Members

  1. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): ObfuscatorAnnotatorModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  6. val ageRanges: IntArrayParam

    List of integers specifying limits of the age groups to preserve during obfuscation

    List of integers specifying limits of the age groups to preserve during obfuscation

    Definition Classes
    BaseDeidParams
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  9. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  10. final def clear(param: Param[_]): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    Params
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. final def copy(extra: ParamMap): Estimator[ObfuscatorAnnotatorModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  13. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  14. val dateFormats: StringArrayParam

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  15. val days: IntParam

    Number of days to obfuscate the dates by displacement.

    Number of days to obfuscate the dates by displacement. If not provided a random integer between 1 and 60 will be used

    Definition Classes
    BaseDeidParams
  16. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  17. val description: String
    Definition Classes
    ObfuscatorAnnotatorApproach → AnnotatorApproach
  18. val entity: Param[String]
    Definition Classes
    ObfuscatorParams
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  22. def explainParams(): String
    Definition Classes
    Params
  23. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  24. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. final def fit(dataset: Dataset[_]): ObfuscatorAnnotatorModel
    Definition Classes
    AnnotatorApproach → Estimator
  27. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[ObfuscatorAnnotatorModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  28. def fit(dataset: Dataset[_], paramMap: ParamMap): ObfuscatorAnnotatorModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  29. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): ObfuscatorAnnotatorModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  30. val genderAwareness: BooleanParam

    Whether to use gender-aware names or not during obfuscation.

    Whether to use gender-aware names or not during obfuscation. This param effects only names. If value is true, it might decrease performance. Default: False

    Definition Classes
    BaseDeidParams
  31. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  32. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  33. def getDateFormats: Array[String]
    Definition Classes
    BaseDeidParams
  34. def getDays: Int
    Definition Classes
    BaseDeidParams
  35. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  36. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  37. def getLanguage: String
    Definition Classes
    BaseDeidParams
  38. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  39. def getObfuscateRefSource: String
    Definition Classes
    BaseDeidParams
  40. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  41. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  42. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  43. def getSameLengthFormattedEntities(): Array[String]
    Definition Classes
    BaseDeidParams
  44. def getSeed(): Int
    Definition Classes
    BaseDeidParams
  45. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  46. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  47. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  48. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  49. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. val inputAnnotatorTypes: Array[AnnotatorType]
    Definition Classes
    ObfuscatorAnnotatorApproach → HasInputAnnotationCols
  51. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  52. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  53. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  54. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  55. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  56. val language: Param[String]

    The language used to select the regex file and some faker entities.

    The language used to select the regex file and some faker entities. 'en'(English),'de'(German), 'es'(Spanish), 'fr'(French), 'ar'(Arabic) or 'ro'(Romanian) Default:'en'

    Definition Classes
    BaseDeidParams
  57. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  58. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  59. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  66. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  71. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  72. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  73. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  74. val obfuscateRefFile: Param[String]

    File with the terms to be used for Obfuscation

    File with the terms to be used for Obfuscation

    Definition Classes
    DeidApproachParams
  75. val obfuscateRefSource: Param[String]

    The source of obfuscation to obfuscate the entities.

    The source of obfuscation to obfuscate the entities. The values ar the following: 'file': Takes the entities from the obfuscatorRefFile 'faker': Takes the entities from the Faker module 'both': Takes the entities from the obfuscatorRefFile and the faker module randomly.

    Definition Classes
    BaseDeidParams
  76. def onTrained(model: ObfuscatorAnnotatorModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  77. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  78. val outputAnnotatorType: AnnotatorType
    Definition Classes
    ObfuscatorAnnotatorApproach → HasOutputAnnotatorType
  79. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  80. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  81. val refFileFormat: Param[String]

    Format of the reference file for Obfuscation the default value for that is "csv"

    Format of the reference file for Obfuscation the default value for that is "csv"

    Definition Classes
    DeidApproachParams
  82. val refSep: Param[String]

    Separator character for the csv reference file for Obfuscation de default value is "#"

    Separator character for the csv reference file for Obfuscation de default value is "#"

    Definition Classes
    DeidApproachParams
  83. val sameLengthFormattedEntities: StringArrayParam

    List of formatted entities to generate the same length outputs as original ones during obfuscation.

    List of formatted entities to generate the same length outputs as original ones during obfuscation. The supported and default formatted entities are: "phone", "fax", "id", "idnum", "bioid", "medicalrecord", "zip", "vin", "ssn", "dln", "plate", "license", "IRS", "CFN".

    Definition Classes
    BaseDeidParams
  84. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  85. val seed: IntParam

    It is the seed to select the entities on obfuscate mode.

    It is the seed to select the entities on obfuscate mode. With the seed, you can reply to an execution several times with the same output.

    Definition Classes
    BaseDeidParams
  86. final def set(paramPair: ParamPair[_]): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  87. final def set(param: String, value: Any): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  88. final def set[T](param: Param[T], value: T): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    Params
  89. def setAgeRanges(mode: Array[Int]): ObfuscatorAnnotatorApproach.this.type

    List of integers specifying limits of the age groups to preserve during obfuscation

    List of integers specifying limits of the age groups to preserve during obfuscation

    Definition Classes
    BaseDeidParams
  90. def setDateFormats(s: Array[String]): ObfuscatorAnnotatorApproach.this.type

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  91. def setDays(k: Int): ObfuscatorAnnotatorApproach.this.type

    Number of days to obfuscate the dates by displacement.

    Number of days to obfuscate the dates by displacement. If not provided a random integer between 1 and 60 will be used

    Definition Classes
    BaseDeidParams
  92. final def setDefault(paramPairs: ParamPair[_]*): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  93. final def setDefault[T](param: Param[T], value: T): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  94. def setEntity(e: String): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    ObfuscatorParams
  95. def setGenderAwareness(value: Boolean): ObfuscatorAnnotatorApproach.this.type

    Whether to use gender-aware names or not during obfuscation.

    Whether to use gender-aware names or not during obfuscation. This param effects only names. If value is true, it might decrease performance. Default: False

    Definition Classes
    BaseDeidParams
  96. final def setInputCols(value: String*): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  97. def setInputCols(value: Array[String]): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  98. def setLanguage(s: String): ObfuscatorAnnotatorApproach.this.type

    The language used to select the regex file and some faker entities.

    The language used to select the regex file and some faker entities. 'en'(English),'de'(German), 'es'(Spanish), 'fr'(French), 'ar'(Arabic) or 'ro'(Romanian). Default:'en'

    Definition Classes
    BaseDeidParams
  99. def setLazyAnnotator(value: Boolean): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    CanBeLazy
  100. def setObfuscateRefFile(f: String): ObfuscatorAnnotatorApproach.this.type

    File with the terms to be used for Obfuscation

    File with the terms to be used for Obfuscation

    Definition Classes
    DeidApproachParams
  101. def setObfuscateRefSource(s: String): ObfuscatorAnnotatorApproach.this.type

    The source of obfuscation to obfuscate the entities.

    The source of obfuscation to obfuscate the entities. The values are the following: 'file': Takes the entities from the obfuscatorRefFile 'faker': Takes the entities from the Faker module 'both': Takes the entities from the obfuscatorRefFile and the faker module randomly.

    Definition Classes
    BaseDeidParams
  102. final def setOutputCol(value: String): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    HasOutputAnnotationCol
  103. def setRefFileFormat(f: String): ObfuscatorAnnotatorApproach.this.type

    File with the terms to be used for Obfuscation

    File with the terms to be used for Obfuscation

    Definition Classes
    DeidApproachParams
  104. def setRefSep(f: String): ObfuscatorAnnotatorApproach.this.type

    Separator character for the csv reference file for Obfuscation de default value is "#"

    Separator character for the csv reference file for Obfuscation de default value is "#"

    Definition Classes
    DeidApproachParams
  105. def setSameLengthFormattedEntities(entities: Array[String]): ObfuscatorAnnotatorApproach.this.type

    List of formatted entities to generate the same length outputs as original ones during obfuscation.

    List of formatted entities to generate the same length outputs as original ones during obfuscation. The supported and default formatted entities are: PHONE, FAX, ID, IDNUM, BIOID, MEDICALRECORD, ZIP, VIN, SSN, DLN, LICENSE, PLATE, IRS, CFN.

    Definition Classes
    BaseDeidParams
  106. def setSeed(s: Int): ObfuscatorAnnotatorApproach.this.type

    It is the seed to select the entities on obfuscate mode.

    It is the seed to select the entities on obfuscate mode. With the seed, you can reply to an execution several times with the same output.

    Definition Classes
    BaseDeidParams
  107. def setUseRandomDateDisplacement(s: Boolean): ObfuscatorAnnotatorApproach.this.type

    Use a random displacement days in dates entities,that random number is based on the BaseDeidParams.seed If true use random displacement days in dates entities, if false use the BaseDeidParams.days The default value is false.

    Use a random displacement days in dates entities,that random number is based on the BaseDeidParams.seed If true use random displacement days in dates entities, if false use the BaseDeidParams.days The default value is false.

    Definition Classes
    ObfuscatorParams
  108. val supportedFormattedEntities: Array[String]
    Attributes
    protected
    Definition Classes
    BaseDeidParams
  109. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  110. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  111. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): ObfuscatorAnnotatorModel
    Definition Classes
    ObfuscatorAnnotatorApproach → AnnotatorApproach
  112. final def transformSchema(schema: StructType): StructType
    Definition Classes
    AnnotatorApproach → PipelineStage
  113. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  114. val uid: String
    Definition Classes
    ObfuscatorAnnotatorApproach → Identifiable
  115. val useRandomDateDisplacement: BooleanParam

    Use a random displacement days in dates entities,that random number is based on the seed If true use random displacement days in dates entities,if false use the ObfuscatorParams.days The default value is false.

    Use a random displacement days in dates entities,that random number is based on the seed If true use random displacement days in dates entities,if false use the ObfuscatorParams.days The default value is false.

    Definition Classes
    ObfuscatorParams
  116. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  117. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  120. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from ObfuscatorParams

Inherited from BaseDeidParams

Inherited from DeidApproachParams

Inherited from AnnotatorApproach[ObfuscatorAnnotatorModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[ObfuscatorAnnotatorModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

Parameter setters

Ungrouped