trait BaseDeidParams extends Params

A trait that contains all the params that are common in DeIdentificationParams and ObfuscatorParams.

See also

DeIdentificationParams

ObfuscatorParams

DeidModelParams

Linear Supertypes
Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
DeIdentification, DeIdentificationModel, DeIdentificationParams, DeidModelParams, LightDeIdentification, ObfuscatorAnnotatorApproach, ObfuscatorAnnotatorModel, ObfuscatorParams
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. BaseDeidParams
  2. Params
  3. Serializable
  4. Serializable
  5. Identifiable
  6. AnyRef
  7. 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

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def clear(param: Param[_]): BaseDeidParams.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

  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

  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

  21. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def getDateFormats: Array[String]
  24. def getDays: Int
  25. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  26. def getLanguage: String
  27. def getObfuscateRefSource: String
  28. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  29. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  30. def getSameLengthFormattedEntities(): Array[String]
  31. def getSeed(): Int
  32. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  33. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  34. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  38. 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'

  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. 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.

  43. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  44. 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".

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

  46. final def set(paramPair: ParamPair[_]): BaseDeidParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  47. final def set(param: String, value: Any): BaseDeidParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  48. final def set[T](param: Param[T], value: T): BaseDeidParams.this.type
    Definition Classes
    Params
  49. def setAgeRanges(mode: Array[Int]): BaseDeidParams.this.type

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

  50. def setDateFormats(s: Array[String]): BaseDeidParams.this.type

    Format of dates to displace

  51. def setDays(k: Int): BaseDeidParams.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

  52. final def setDefault(paramPairs: ParamPair[_]*): BaseDeidParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  53. final def setDefault[T](param: Param[T], value: T): BaseDeidParams.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  54. def setGenderAwareness(value: Boolean): BaseDeidParams.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

  55. def setLanguage(s: String): BaseDeidParams.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'

  56. def setObfuscateRefSource(s: String): BaseDeidParams.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.

  57. def setSameLengthFormattedEntities(entities: Array[String]): BaseDeidParams.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.

  58. def setSeed(s: Int): BaseDeidParams.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.

  59. val supportedFormattedEntities: Array[String]
    Attributes
    protected
  60. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  61. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

Parameter setters

Ungrouped