Packages

class RegexMatcherInternalModel extends AnnotatorModel[RegexMatcherInternalModel] with HasSimpleAnnotate[RegexMatcherInternalModel] with MergeCommonParams with CheckLicense

Instantiated model of the RegexMatcherInternal. For usage and examples see the documentation of the main class.

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

Instance Constructors

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

    uid

    internal element required for storing annotator to disk

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]

    one-to-many annotation that returns matches as annotations

    one-to-many annotation that returns matches as annotations

    Definition Classes
    RegexMatcherInternalModel → 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], metadata: Option[Map[String, Value]]): Unit
    Definition Classes
    CheckLicense
  16. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean, metadata: Option[Map[String, Value]]): Unit
    Definition Classes
    CheckLicense
  18. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean, metadata: Option[Map[String, Value]]): Unit
    Definition Classes
    CheckLicense
  19. final def clear(param: Param[_]): RegexMatcherInternalModel.this.type
    Definition Classes
    Params
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def copy(extra: ParamMap): RegexMatcherInternalModel
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  22. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  23. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  28. def explainParams(): String
    Definition Classes
    Params
  29. val externalRules: ArrayFeature[(String, String)]

    rules

  30. final val extraInputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  31. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  32. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  33. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  34. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  35. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  36. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. def getExternalRules: Array[(String, String)]

    Rules represented as Array of Tuples

  45. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  46. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  47. def getMergeOverlapping: Boolean
    Definition Classes
    MergeCommonParams
  48. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  49. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  50. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  51. def getStrategy: String

    Can be any of MATCH_FIRST|MATCH_ALL|MATCH_COMPLETE

  52. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  53. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  54. def hasParent: Boolean
    Definition Classes
    Model
  55. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  56. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  57. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator type: DOCUMENT

    Input annotator type: DOCUMENT

    Definition Classes
    RegexMatcherInternalModel → HasInputAnnotationCols
  59. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  60. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  61. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  62. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  63. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  64. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  65. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  66. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  73. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. val mergeOverlapping: BooleanParam

    whether to merge overlapping matched chunks.

    whether to merge overlapping matched chunks. Defaults to true

    Definition Classes
    MergeCommonParams
  78. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  79. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  80. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  81. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  82. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  83. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  84. val outputAnnotatorType: AnnotatorType

    Input annotator type: CHUNK

    Input annotator type: CHUNK

    Definition Classes
    RegexMatcherInternalModel → HasOutputAnnotatorType
  85. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  86. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  87. var parent: Estimator[RegexMatcherInternalModel]
    Definition Classes
    Model
  88. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  89. def set[T](feature: StructFeature[T], value: T): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. def set[T](feature: SetFeature[T], value: Set[T]): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def set[T](feature: ArrayFeature[T], value: Array[T]): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. final def set(paramPair: ParamPair[_]): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  94. final def set(param: String, value: Any): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  95. final def set[T](param: Param[T], value: T): RegexMatcherInternalModel.this.type
    Definition Classes
    Params
  96. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. final def setDefault(paramPairs: ParamPair[_]*): RegexMatcherInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def setDefault[T](param: Param[T], value: T): RegexMatcherInternalModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  102. def setExternalRules(value: Array[(String, String)]): RegexMatcherInternalModel.this.type

    Path to file containing a set of regex,key pair.

    Path to file containing a set of regex,key pair. readAs can be LINE_BY_LINE or SPARK_DATASET. options contain option passed to spark reader if readAs is SPARK_DATASET.

  103. def setExtraInputCols(value: Array[String]): RegexMatcherInternalModel.this.type
    Definition Classes
    HasInputAnnotationCols
  104. final def setInputCols(value: String*): RegexMatcherInternalModel.this.type
    Definition Classes
    HasInputAnnotationCols
  105. def setInputCols(value: Array[String]): RegexMatcherInternalModel.this.type
    Definition Classes
    HasInputAnnotationCols
  106. def setLazyAnnotator(value: Boolean): RegexMatcherInternalModel.this.type
    Definition Classes
    CanBeLazy
  107. def setMergeOverlapping(v: Boolean): RegexMatcherInternalModel.this.type

    whether to merge overlapping matched chunks.

    whether to merge overlapping matched chunks.

    Definition Classes
    MergeCommonParams
  108. final def setOutputCol(value: String): RegexMatcherInternalModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  109. def setParent(parent: Estimator[RegexMatcherInternalModel]): RegexMatcherInternalModel
    Definition Classes
    Model
  110. def setStrategy(value: String): RegexMatcherInternalModel.this.type

    Can be any of MATCH_FIRST|MATCH_ALL|MATCH_COMPLETE

  111. val strategy: Param[String]

    MATCH_ALL|MATCH_FIRST|MATCH_COMPLETE

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

Inherited from CheckLicense

Inherited from MergeCommonParams

Inherited from HasSimpleAnnotate[RegexMatcherInternalModel]

Inherited from AnnotatorModel[RegexMatcherInternalModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[RegexMatcherInternalModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[RegexMatcherInternalModel]

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

getParams

Parameters

A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.

Annotator types

Required input and expected output annotator types

Members

Parameter setters