org.apache.spark.ml.feature

Class StopWordsRemover

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.feature.StopWordsRemover

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public class StopWordsRemover
extends Transformer

:: Experimental :: A feature transformer that filters out stop words from input. Note: null values from input array are preserved unless adding null to stopWords explicitly.

See Also:

, Serialized Form

Constructor Summary

Constructors

Constructor and Description
StopWordsRemover()
StopWordsRemover(java.lang.String uid)

Method Summary

Methods

Modifier and Type	Method and Description
BooleanParam	caseSensitive() whether to do a case sensitive comparison over the stop words Default: false
StopWordsRemover	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
boolean	getCaseSensitive()
java.lang.String[]	getStopWords()
StopWordsRemover	setCaseSensitive(boolean value)
StopWordsRemover	setInputCol(java.lang.String value)
StopWordsRemover	setOutputCol(java.lang.String value)
StopWordsRemover	setStopWords(java.lang.String[] value)
StringArrayParam	stopWords() the stop words set to be filtered out Default: StopWords.English
DataFrame	transform(DataFrame dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
java.lang.String	uid() An immutable unique ID for the object and its derivatives.

Methods inherited from class org.apache.spark.ml.Transformer

transform, transform, transform

Methods inherited from class org.apache.spark.ml.PipelineStage

transformSchema

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn, validateParams

Methods inherited from interface org.apache.spark.ml.util.Identifiable

toString

Methods inherited from interface org.apache.spark.Logging

initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

StopWordsRemover

public StopWordsRemover(java.lang.String uid)

StopWordsRemover

public StopWordsRemover()

Method Detail

uid

public java.lang.String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Returns:

(undocumented)

setInputCol

public StopWordsRemover setInputCol(java.lang.String value)

setOutputCol

public StopWordsRemover setOutputCol(java.lang.String value)

stopWords

public StringArrayParam stopWords()

the stop words set to be filtered out Default: StopWords.English

Returns:

(undocumented)

setStopWords

public StopWordsRemover setStopWords(java.lang.String[] value)

getStopWords

public java.lang.String[] getStopWords()

caseSensitive

public BooleanParam caseSensitive()

whether to do a case sensitive comparison over the stop words Default: false

Returns:

(undocumented)

setCaseSensitive

public StopWordsRemover setCaseSensitive(boolean value)

getCaseSensitive

public boolean getCaseSensitive()

transform

public DataFrame transform(DataFrame dataset)

Description copied from class: Transformer

Transforms the input dataset.

Specified by:

transform in class Transformer

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: DeveloperApi ::

Derives the output schema from the input schema.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

copy

public StopWordsRemover copy(ParamMap extra)

Description copied from interface: Params

Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly.

Specified by:

copy in interface Params

Specified by:

copy in class Transformer

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()