trait ObfuscatorParams extends BaseDeidParams

A trait that contains all the params that are common in ObfuscatorAnnotatorModel and ObfuscatorAnnotatorApproach

Attributes
protected
See also

ObfuscatorAnnotatorModel

ObfuscatorAnnotatorApproach

BaseDeidParams

Linear Supertypes
BaseDeidParams, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
ObfuscatorAnnotatorApproach, ObfuscatorAnnotatorModel
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ObfuscatorParams
  2. BaseDeidParams
  3. Params
  4. Serializable
  5. Serializable
  6. Identifiable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params
    Definition Classes
    Params
  2. abstract val uid: String
    Definition Classes
    Identifiable

Concrete 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. 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
  6. val ageRangesByHipaa: BooleanParam

    A Boolean variable indicating whether to obfuscate ages based on HIPAA (Health Insurance Portability and Accountability Act) Privacy Rule.

    A Boolean variable indicating whether to obfuscate ages based on HIPAA (Health Insurance Portability and Accountability Act) Privacy Rule.

    The HIPAA Privacy Rule mandates that ages from patients older than 90 years must be obfuscated, while age for patients 90 years or younger can remain unchanged.

    When true, age entities larger than 90 will be obfuscated as per HIPAA Privacy Rule, the others will remain unchanged. When false, ageRanges parameter is valid.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. final def clear(param: Param[_]): ObfuscatorParams.this.type
    Definition Classes
    Params
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  11. val dateFormats: StringArrayParam

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  12. 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
  13. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  14. val entity: Param[String]
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  18. def explainParams(): String
    Definition Classes
    Params
  19. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  20. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  21. val fakerLengthOffset: IntParam

    It specifies how much length deviation is accepted in obfuscation, with keepTextSizeForObfuscation enabled.

    It specifies how much length deviation is accepted in obfuscation, with keepTextSizeForObfuscation enabled. Value must be greater than 0. Default is 3.

  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. 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
  24. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def getDateFormats: Array[String]
    Definition Classes
    BaseDeidParams
  27. def getDays: Int
    Definition Classes
    BaseDeidParams
  28. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  29. def getEntity: String
  30. def getFakerLengthOffset: Int

    Gets fakerLengthOffset param

  31. def getKeepMonth: Boolean

    Gets keepMonth param

  32. def getKeepTextSizeForObfuscation: Boolean

    Gets keepTextSizeForObfuscation param

  33. def getKeepYear: Boolean

    Gets keepYear param

  34. def getLanguage: String
    Definition Classes
    BaseDeidParams
  35. def getObfuscateRefSource: String
    Definition Classes
    BaseDeidParams
  36. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  37. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  38. def getSameLengthFormattedEntities(): Array[String]
    Definition Classes
    BaseDeidParams
  39. def getSeed(): Int
    Definition Classes
    BaseDeidParams
  40. def getUnnormalizedDateMode: String

    Gets unnormalizedDateMode param

  41. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  42. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  43. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  47. val keepMonth: BooleanParam

    Whether to keep the month intact when obfuscating date entities.

    Whether to keep the month intact when obfuscating date entities. If true, the month will remain unchanged during the obfuscation process. If false, the month will be modified along with the year and day. Default: false.

  48. val keepTextSizeForObfuscation: BooleanParam

    It specifies whether the output should maintain the same character length as the input text.

    It specifies whether the output should maintain the same character length as the input text. the output text will remain the same if same length is available, else length might vary.

  49. val keepYear: BooleanParam

    Whether to keep the year intact when obfuscating date entities.

    Whether to keep the year intact when obfuscating date entities. If true, the year will remain unchanged during the obfuscation process. If false, the year will be modified along with the month and day. Default: false.

  50. 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
  51. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  54. 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
  55. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  56. val region: Param[String]

    With this property, you can select particular dateFormats.

    With this property, you can select particular dateFormats. This property is especially used when obfuscating dates. You can decide whether the first part of 11/11/2023 is a day or the second part is a day when obfuscating dates. The values are following: 'eu' for European Union 'us' for USA Default: 'eu'

  57. 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", "contact," "id", "idnum", "bioid", "medicalrecord", "zip", "vin", "ssn", "dln", "plate", "license", "IRS", "CFN", "account".

    Definition Classes
    BaseDeidParams
  58. 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
  59. final def set(paramPair: ParamPair[_]): ObfuscatorParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  60. final def set(param: String, value: Any): ObfuscatorParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  61. final def set[T](param: Param[T], value: T): ObfuscatorParams.this.type
    Definition Classes
    Params
  62. def setAgeRanges(mode: Array[Int]): ObfuscatorParams.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
  63. def setAgeRangesByHipaa(value: Boolean): ObfuscatorParams.this.type

    Sets whether to obfuscate ages based on HIPAA (Health Insurance Portability and Accountability Act) Privacy Rule.

    Sets whether to obfuscate ages based on HIPAA (Health Insurance Portability and Accountability Act) Privacy Rule.

    The HIPAA Privacy Rule mandates that ages from patients older than 90 years must be obfuscated, while age for patients 90 years or younger can remain unchanged.

    value

    If true, age entities larger than 90 will be obfuscated as per HIPAA Privacy Rule, the others will remain unchanged. If false, ageRanges parameter is valid. Default: false.

  64. def setDateFormats(s: Array[String]): ObfuscatorParams.this.type

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  65. def setDays(k: Int): ObfuscatorParams.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
  66. final def setDefault(paramPairs: ParamPair[_]*): ObfuscatorParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  67. final def setDefault[T](param: Param[T], value: T): ObfuscatorParams.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  68. def setEntity(e: String): ObfuscatorParams.this.type
  69. def setFakerLengthOffset(value: Int): ObfuscatorParams.this.type

    Sets fakerLengthOffset param

  70. def setGenderAwareness(value: Boolean): ObfuscatorParams.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
  71. def setKeepMonth(value: Boolean): ObfuscatorParams.this.type

    Sets whether to keep the month intact when obfuscating date entities.

    Sets whether to keep the month intact when obfuscating date entities. If true, the month will remain unchanged during the obfuscation process. If false, the month will be modified along with the year and day. Default: false.

  72. def setKeepTextSizeForObfuscation(value: Boolean): ObfuscatorParams.this.type

    Sets keepTextSizeForObfuscation param

  73. def setKeepYear(value: Boolean): ObfuscatorParams.this.type

    Sets whether to keep the year intact when obfuscating date entities.

    Sets whether to keep the year intact when obfuscating date entities. If true, the year will remain unchanged during the obfuscation process. If false, the year will be modified along with the month and day. Default: false.

  74. def setLanguage(s: String): ObfuscatorParams.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
  75. def setObfuscateRefSource(s: String): ObfuscatorParams.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
  76. def setRegion(s: String): ObfuscatorParams.this.type

    With this property, you can select particular dateFormats.

    With this property, you can select particular dateFormats. This property is especially used when obfuscating dates. You can decide whether the first part of 11/11/2023 is a day or the second part is a day when obfuscating dates. The values are following: 'eu' for European Union 'us' for USA Default: 'eu'

  77. def setSameLengthFormattedEntities(entities: Array[String]): ObfuscatorParams.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, CONTACT, ID, IDNUM, BIOID, MEDICALRECORD, ZIP, VIN, SSN, DLN, LICENSE, PLATE, IRS, CFN, ACCOUNT.

    Definition Classes
    BaseDeidParams
  78. def setSeed(s: Int): ObfuscatorParams.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
  79. def setUnnormalizedDateMode(mode: String): ObfuscatorParams.this.type

    The mode to use if the date is not formatted.

    The mode to use if the date is not formatted. [mask, obfuscate, skip] Default: obfuscate

  80. def setUseRandomDateDisplacement(s: Boolean): ObfuscatorParams.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.

  81. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  82. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  83. val unnormalizedDateMode: Param[String]

    The mode to use if the date is not formatted.

    The mode to use if the date is not formatted. [mask, obfuscate, skip] Default: obfuscate

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

  85. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  87. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from BaseDeidParams

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

Parameter setters

Ungrouped