Packages

class RegexMatcher extends AnnotatorApproach[RegexMatcherModel]

Uses a reference file to match a set of regular expressions and put them inside a provided key. File must be comma separated.

Matches regular expressions and maps them to specified values optionally provided

Rules are provided from external source file

Linear Supertypes
AnnotatorApproach[RegexMatcherModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[RegexMatcherModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. RegexMatcher
  2. AnnotatorApproach
  3. CanBeLazy
  4. DefaultParamsWritable
  5. MLWritable
  6. HasOutputAnnotatorType
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. Estimator
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    internal element required for storing annotator to disk

Type Members

  1. 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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): RegexMatcherModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  8. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  9. final def clear(param: Param[_]): RegexMatcher.this.type
    Definition Classes
    Params
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. final def copy(extra: ParamMap): Estimator[RegexMatcherModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  12. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  13. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  14. val description: String

    Matches described regex rules that come in tuples in a text file

    Matches described regex rules that come in tuples in a text file

    Definition Classes
    RegexMatcher → AnnotatorApproach
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  18. def explainParams(): String
    Definition Classes
    Params
  19. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  20. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def fit(dataset: Dataset[_]): RegexMatcherModel
    Definition Classes
    AnnotatorApproach → Estimator
  23. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[RegexMatcherModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  24. def fit(dataset: Dataset[_], paramMap: ParamMap): RegexMatcherModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  25. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): RegexMatcherModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  26. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  29. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  30. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  31. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  32. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  33. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  34. def getStrategy: String

    Can be any of MATCH_FIRST|MATCH_ALL|MATCH_COMPLETE

  35. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  36. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  37. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  38. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  39. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator type: DOCUMENT

    Input annotator type: DOCUMENT

    Definition Classes
    RegexMatcher → HasInputAnnotationCols
  41. final val inputCols: StringArrayParam

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  42. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  45. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  46. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  47. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  48. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  55. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  60. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  62. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  63. def onTrained(model: RegexMatcherModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  64. val outputAnnotatorType: AnnotatorType

    Input annotator type: CHUNK

    Input annotator type: CHUNK

    Definition Classes
    RegexMatcher → HasOutputAnnotatorType
  65. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  66. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  67. val rules: ExternalResourceParam

    external resource to rules, needs 'delimiter' in options

  68. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  69. final def set(paramPair: ParamPair[_]): RegexMatcher.this.type
    Attributes
    protected
    Definition Classes
    Params
  70. final def set(param: String, value: Any): RegexMatcher.this.type
    Attributes
    protected
    Definition Classes
    Params
  71. final def set[T](param: Param[T], value: T): RegexMatcher.this.type
    Definition Classes
    Params
  72. final def setDefault(paramPairs: ParamPair[_]*): RegexMatcher.this.type
    Attributes
    protected
    Definition Classes
    Params
  73. final def setDefault[T](param: Param[T], value: T): RegexMatcher.this.type
    Attributes
    protected
    Definition Classes
    Params
  74. final def setInputCols(value: String*): RegexMatcher.this.type
    Definition Classes
    HasInputAnnotationCols
  75. final def setInputCols(value: Array[String]): RegexMatcher.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  76. def setLazyAnnotator(value: Boolean): RegexMatcher.this.type
    Definition Classes
    CanBeLazy
  77. final def setOutputCol(value: String): RegexMatcher.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  78. def setRules(path: String, delimiter: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map("format" -> "text")): RegexMatcher.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.

  79. def setRules(value: ExternalResource): RegexMatcher.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.

  80. def setStrategy(value: String): RegexMatcher.this.type

    Can be any of MATCH_FIRST|MATCH_ALL|MATCH_COMPLETE

  81. val strategy: Param[String]

    MATCH_ALL|MATCH_FIRST|MATCH_COMPLETE

  82. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  83. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  84. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): RegexMatcherModel
    Definition Classes
    RegexMatcher → AnnotatorApproach
  85. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    AnnotatorApproach → PipelineStage
  86. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  87. val uid: String
    Definition Classes
    RegexMatcher → Identifiable
  88. def validate(schema: StructType): Boolean

    takes a Dataset and checks to see if all the required annotation types are present.

    takes a Dataset and checks to see if all the required annotation types are present.

    schema

    to be validated

    returns

    True if all the required types are present, else false

    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  89. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  90. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  91. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  92. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from AnnotatorApproach[RegexMatcherModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[RegexMatcherModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters