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
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 valid ageRanges whether ageRangesByHipaa is true or not.

    Gets valid ageRanges whether ageRangesByHipaa is true or not.

    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. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  10. val dateFormats: StringArrayParam

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  11. 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
  12. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  16. def explainParams(): String
    Definition Classes
    Params
  17. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  18. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. 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
  21. def generateFakeBySameLength(wordToReplace: String, entity: String): String

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

  22. def generateFakeBySameLengthUsingHash(wordToReplace: String, entity: String): String
    Attributes
    protected
  23. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def getDateFormats: Array[String]
    Definition Classes
    BaseDeidParams
  26. def getDays: Int
    Definition Classes
    BaseDeidParams
  27. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  28. def getFakeByHashcode(fakes: Seq[String], wordToReplace: String, entity: String, seed: Int): String
    Attributes
    protected
  29. def getFakersEntity(entity: String, result: String): Seq[String]
  30. def getLanguage: String
    Definition Classes
    BaseDeidParams
  31. def getObfuscateRefSource: String
    Definition Classes
    BaseDeidParams
  32. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  33. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  34. def getSameLengthFormattedEntities(): Array[String]
    Definition Classes
    BaseDeidParams
  35. def getSeed(): Int
    Definition Classes
    BaseDeidParams
  36. def handleCasing(originalFake: String, wordToReplace: String): String
    Attributes
    protected
  37. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  38. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  39. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  41. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  42. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  43. 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
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. 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
  48. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  49. val random: SecureRandom
    Attributes
    protected
  50. 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
  51. 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
  52. final def set(paramPair: ParamPair[_]): DeidModelParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  53. final def set(param: String, value: Any): DeidModelParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  54. final def set[T](param: Param[T], value: T): DeidModelParams.this.type
    Definition Classes
    Params
  55. 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
  56. def setDateFormats(s: Array[String]): DeidModelParams.this.type

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  57. 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
  58. final def setDefault(paramPairs: ParamPair[_]*): DeidModelParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  59. final def setDefault[T](param: Param[T], value: T): DeidModelParams.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  60. 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
  61. 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
  62. 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
  63. 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
  64. 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
  65. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  66. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  67. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. 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