c

com.johnsnowlabs.nlp.annotators.deid

DateChunkObfuscator

class DateChunkObfuscator extends AnnotatorModel[DateChunkObfuscator] with HasSimpleAnnotate[DateChunkObfuscator] with CheckLicense

Linear Supertypes
CheckLicense, HasSimpleAnnotate[DateChunkObfuscator], AnnotatorModel[DateChunkObfuscator], CanBeLazy, RawAnnotator[DateChunkObfuscator], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[DateChunkObfuscator], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DateChunkObfuscator
  2. CheckLicense
  3. HasSimpleAnnotate
  4. AnnotatorModel
  5. CanBeLazy
  6. RawAnnotator
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. HasOutputAnnotatorType
  10. ParamsAndFeaturesWritable
  11. HasFeatures
  12. DefaultParamsWritable
  13. MLWritable
  14. Model
  15. Transformer
  16. PipelineStage
  17. Logging
  18. Params
  19. Serializable
  20. Serializable
  21. Identifiable
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

Type Members

  1. type AnnotationContent = Seq[Row]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. 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. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]
    Definition Classes
    DateChunkObfuscator → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  16. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  18. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  19. final def clear(param: Param[_]): DateChunkObfuscator.this.type
    Definition Classes
    Params
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def copy(extra: ParamMap): DateChunkObfuscator
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  22. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  23. val dateFormats: StringArrayParam

    Format of dates to displace

  24. val dateToYear: BooleanParam

    true if dates must be converted to years, false otherwise

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

  26. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  27. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  30. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  31. def explainParams(): String
    Definition Classes
    Params
  32. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  33. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  34. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  35. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  36. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  37. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  42. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  43. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  45. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  46. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  47. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  48. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  49. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  50. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  51. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  52. def hasParent: Boolean
    Definition Classes
    Model
  53. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  54. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  55. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. val inputAnnotatorTypes: Array[String]
    Definition Classes
    DateChunkObfuscator → HasInputAnnotationCols
  57. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  58. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  59. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  60. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  61. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  62. val language: Param[String]

    The language used to obfuscate date entities.

    The language used to obfuscate date entities. 'en'(English), 'de'(German), 'es'(Spanish), 'fr'(French), 'ar'(Arabic) or 'ro'(Romanian). Default: 'en'

  63. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  64. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  65. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  72. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. val minYear: IntParam

    Minimum year to use when converting date to year

  77. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  78. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  79. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  81. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  82. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  83. val outputAnnotatorType: AnnotatorType
    Definition Classes
    DateChunkObfuscator → HasOutputAnnotatorType
  84. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  85. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  86. var parent: Estimator[DateChunkObfuscator]
    Definition Classes
    Model
  87. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  88. val seed: IntParam

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

  89. def set[T](feature: StructFeature[T], value: T): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. def set[T](feature: SetFeature[T], value: Set[T]): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def set[T](feature: ArrayFeature[T], value: Array[T]): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. final def set(paramPair: ParamPair[_]): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    Params
  94. final def set(param: String, value: Any): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    Params
  95. final def set[T](param: Param[T], value: T): DateChunkObfuscator.this.type
    Definition Classes
    Params
  96. def setDateFormats(s: Array[String]): DateChunkObfuscator.this.type

    Format of dates to displace

  97. def setDateToYear(s: Boolean): DateChunkObfuscator.this.type

    true if dates must be converted to years, false otherwise

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

  99. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  101. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  102. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  103. final def setDefault(paramPairs: ParamPair[_]*): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    Params
  104. final def setDefault[T](param: Param[T], value: T): DateChunkObfuscator.this.type
    Attributes
    protected
    Definition Classes
    Params
  105. final def setInputCols(value: String*): DateChunkObfuscator.this.type
    Definition Classes
    HasInputAnnotationCols
  106. def setInputCols(value: Array[String]): DateChunkObfuscator.this.type
    Definition Classes
    HasInputAnnotationCols
  107. def setLanguage(s: String): DateChunkObfuscator.this.type

    The language used to obfuscate date entities.

    The language used to obfuscate date entities. 'en'(English), 'de'(German), 'es'(Spanish), 'fr'(French), 'ar'(Arabic) or 'ro'(Romanian). Default: 'en'

  108. def setLazyAnnotator(value: Boolean): DateChunkObfuscator.this.type
    Definition Classes
    CanBeLazy
  109. def setMinYear(s: Int): DateChunkObfuscator.this.type

    Minimum year to use when converting date to year

  110. final def setOutputCol(value: String): DateChunkObfuscator.this.type
    Definition Classes
    HasOutputAnnotationCol
  111. def setParent(parent: Estimator[DateChunkObfuscator]): DateChunkObfuscator
    Definition Classes
    Model
  112. def setSeed(s: Int): DateChunkObfuscator.this.type

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

  113. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  114. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  115. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  116. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  117. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  118. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  119. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  120. val uid: String
    Definition Classes
    DateChunkObfuscator → Identifiable
  121. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  122. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  123. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  124. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  125. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  126. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from CheckLicense

Inherited from HasSimpleAnnotate[DateChunkObfuscator]

Inherited from AnnotatorModel[DateChunkObfuscator]

Inherited from CanBeLazy

Inherited from RawAnnotator[DateChunkObfuscator]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[DateChunkObfuscator]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

param

setParam

Ungrouped