trait DeidModelParams extends BaseDeidParams

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

See also

DeIdentificationModel

ObfuscatorAnnotatorModel

BaseDeidParams to see params

Linear Supertypes
BaseDeidParams, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
DeIdentificationModel, LightDeIdentification, ObfuscatorAnnotatorModel, FhirDeIdentification
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DeidModelParams
  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 def getValidAgeRanges: Array[Int]

    Gets validAgeRanges parameter

    Gets validAgeRanges parameter

    Attributes
    protected
  3. 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def clear(param: Param[_]): DeidModelParams.this.type
    Definition Classes
    Params
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. val consistentAcrossNameParts: BooleanParam

    Param that indicates whether consistency should be enforced across different parts of a name (e.g., first name, middle name, last name).

    Param that indicates whether consistency should be enforced across different parts of a name (e.g., first name, middle name, last name). When set to true, the same transformation or obfuscation will be applied consistently to all parts of the same name entity, even if those parts appear separately.

    For example, if "John Smith" is obfuscated as "Liam Brown", then:

    • When the full name "John Smith" appears, it will be replaced with "Liam Brown"
    • When "John" or "Smith" appear individually, they will still be obfuscated as "Liam" and "Brown" respectively, ensuring consistency in name transformation.

    Default: true

    Definition Classes
    BaseDeidParams
  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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  17. def explainParams(): String
    Definition Classes
    Params
  18. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  19. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  20. 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.

    Definition Classes
    BaseDeidParams
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. 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
  23. def generateFakeBySameLength(wordToReplace: String, entity: String): String

    obfuscating digits to new digits, letters to new letters and others remains the same

  24. def generateFakeBySameLengthUsingHash(wordToReplace: String, entity: String): String
    Attributes
    protected
  25. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def getConsistentAcrossNameParts: Boolean

    Gets the value of consistentAcrossNameParts.

    Gets the value of consistentAcrossNameParts.

    returns

    Boolean value indicating if consistency is enforced across name parts

    Definition Classes
    BaseDeidParams
  28. def getDateFormats: Array[String]
    Definition Classes
    BaseDeidParams
  29. def getDays: Int
    Definition Classes
    BaseDeidParams
  30. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  31. def getEntityField(annotation: Annotation): String
    Attributes
    protected
  32. def getFakeByHashcode(fakes: Seq[String], wordToReplace: String, entity: String, seed: Int): String
    Attributes
    protected
  33. def getFakeWithSameSize(fakes: Seq[String], wordToReplace: String, entity: String, lengthDeviation: Int, seed: Int): String
    Attributes
    protected
  34. def getFakerLengthOffset: Int

    Gets fakerLengthOffset param

    Gets fakerLengthOffset param

    Definition Classes
    BaseDeidParams
  35. def getFakersEntity(entity: String, result: String): Seq[String]
  36. def getKeepTextSizeForObfuscation: Boolean

    Gets keepTextSizeForObfuscation param

    Gets keepTextSizeForObfuscation param

    Definition Classes
    BaseDeidParams
  37. def getLanguage: String
    Definition Classes
    BaseDeidParams
  38. def getMaskEntity(entityClazz: String): String
    Attributes
    protected
  39. def getMaskStatus(entityClass: String): String
    Attributes
    protected
  40. def getMaxSentence(annotations: Seq[Annotation]): Int
    Attributes
    protected
  41. def getObfuscateRefSource: String
    Definition Classes
    BaseDeidParams
  42. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  43. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  44. def getSameLengthFormattedEntities(): Array[String]
    Definition Classes
    BaseDeidParams
  45. def getSeed(): Int
    Definition Classes
    BaseDeidParams
  46. def handleCasing(originalFake: String, wordToReplace: String): String
    Attributes
    protected
  47. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  48. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  49. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  50. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  51. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  52. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  53. 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.

    Definition Classes
    BaseDeidParams
  54. 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
  55. def maskEntity(annotation: Annotation, maskingPolicy: String, maskedEntity: String, fixedMaskLength: Int): String
    Attributes
    protected
  56. val nameEntities: Seq[String]
    Attributes
    protected
  57. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  59. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. def obfuscateNameEntity(originalName: String, keepTextSize: Boolean, lengthDeviation: Int, namePartsMemory: Map[String, String]): String
    Attributes
    protected
  61. 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
  62. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  63. val random: SecureRandom
    Attributes
    protected
  64. 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
  65. 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
  66. def selectFakeFromAllFakes(wordToReplace: String, entityClass: String, maskedEntity: String, allFakes: Seq[String]): String
    Attributes
    protected
  67. final def set(paramPair: ParamPair[_]): DeidModelParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  68. final def set(param: String, value: Any): DeidModelParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  69. final def set[T](param: Param[T], value: T): DeidModelParams.this.type
    Definition Classes
    Params
  70. def setAgeRanges(mode: Array[Int]): DeidModelParams.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
  71. def setConsistentAcrossNameParts(value: Boolean): DeidModelParams.this.type

    Sets the value of consistentAcrossNameParts.

    Sets the value of consistentAcrossNameParts.

    value

    Boolean flag to enforce consistency across name parts

    returns

    this instance

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

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  73. def setDays(k: Int): DeidModelParams.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
  74. final def setDefault(paramPairs: ParamPair[_]*): DeidModelParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  75. final def setDefault[T](param: Param[T], value: T): DeidModelParams.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  76. def setFakerLengthOffset(value: Int): DeidModelParams.this.type

    Sets fakerLengthOffset param

    Sets fakerLengthOffset param

    Definition Classes
    BaseDeidParams
  77. def setGenderAwareness(value: Boolean): DeidModelParams.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
  78. def setKeepTextSizeForObfuscation(value: Boolean): DeidModelParams.this.type

    Sets keepTextSizeForObfuscation param

    Sets keepTextSizeForObfuscation param

    Definition Classes
    BaseDeidParams
  79. def setLanguage(s: String): DeidModelParams.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
  80. def setObfuscateRefSource(s: String): DeidModelParams.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
  81. def setSameLengthFormattedEntities(entities: Array[String]): DeidModelParams.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
  82. def setSeed(s: Int): DeidModelParams.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
    DeidModelParams → BaseDeidParams
  83. def shouldUseConsistentNameParts(entityClass: String): Boolean
    Attributes
    protected
  84. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  85. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  86. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  87. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. 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