Package com.orchestranetworks.search.strategy

# Class StopWordsKey

java.lang.Object
com.orchestranetworks.search.strategy.StopWordsKey

public final class StopWordsKey extends Object
Identifies a stop word list.

Since:
  6.0.0
See Also:
  - `StopWordsDeclaration`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `equals(Object obj)`
  `String`
  `format()`
  Returns a persistent identifier for this service key.
  `String`
  `getModel()`
  Returns the name of the data model to which the stop words list belongs, or null if the list does not belong to a specific model.
  `String`
  `getModuleName()`
  `String`
  `getName()`
  `int`
  `hashCode()`
  `static StopWordsKey`
  `parse(String aString)`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, toString, wait, wait, wait`

- ## Method Details

  - ### parse

    public static StopWordsKey parse(String aString)
    Throws:
      `IllegalArgumentException` - if the specified key does not match the regular expression `([-\\d\\pL:_.]*)@?(%?[-\\d\\pL:_. /]+)`.

  - ### getModuleName

    public String getModuleName()

  - ### getModel

    public String getModel()
    Returns the name of the data model to which the stop words list belongs, or null if the list does not belong to a specific model.
    Since:
      6.1.3

  - ### format

    public String format()
    Returns a persistent identifier for this service key.

    The strategy key can be re-obtained by parsing this persistent identifier using the method `parse(String)`.

  - ### getName

    public String getName()
    Since:
      6.1.3

  - ### hashCode

    public int hashCode()
    Overrides:
      `hashCode` in class `Object`

  - ### equals

    public boolean equals(Object obj)
    Overrides:
      `equals` in class `Object`