DictionaryAttribute (Morfologik Stemming APIs v1.7.1 API Documentation)

java.lang.Object
- java.lang.Enum<DictionaryAttribute>
- - morfologik.stemming.DictionaryAttribute

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DictionaryAttribute>
```
public enum DictionaryAttribute
extends java.lang.Enum<DictionaryAttribute>
```
Attributes applying to Dictionary and DictionaryMetadata.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTHOR` Dictionary author.
`CONVERT_CASE` if the spelling dictionary is supposed to treat upper and lower case as equivalent.
`CREATION_DATE` Dictionary creation date.
`ENCODING` Character to byte encoding used for strings inside the FSA.
`EQUIVALENT_CHARS` Equivalent characters (treated similarly as equivalent chars with and without diacritics).
`IGNORE_ALL_UPPERCASE` If the spelling dictionary is supposed to ignore ALL UPPERCASE words.
`IGNORE_CAMEL_CASE` If the spelling dictionary is supposed to ignore CamelCase words.
`IGNORE_DIACRITICS` If the spelling dictionary is supposed to ignore diacritics, so that 'a' would be treated as equivalent to 'ą'.
`IGNORE_NUMBERS` If the spelling dictionary is supposed to ignore words containing digits
`IGNORE_PUNCTUATION` If the spelling dictionary is supposed to ignore punctuation.
`LICENSE` Dictionary license attribute.
`LOCALE` Locale associated with the dictionary.
`REPLACEMENT_PAIRS` Replacement pairs for non-obvious candidate search in a speller dictionary.
`RUN_ON_WORDS` If the spelling dictionary is supposed to split runOnWords.
`SEPARATOR` Logical fields separator inside the FSA.
`USES_INFIXES` If the dictionary was compiled with infix compression.
`USES_PREFIXES` If the dictionary was compiled with prefix compression.

Field Summary

Fields
Modifier and Type Field and Description

java.lang.String propertyName
Property name for this attribute.

Fields
Modifier and Type	Field and Description
`java.lang.String`	`propertyName` Property name for this attribute.

Method Summary

Methods
Modifier and Type	Method and Description
`static DictionaryAttribute`	`fromPropertyName(java.lang.String propertyName)` Return an `DictionaryAttribute` by its `propertyName`.
`java.lang.Object`	`fromString(java.lang.String value)` Converts a string to the given attribute's value (covariants used).
`static DictionaryAttribute`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static DictionaryAttribute[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SEPARATOR
```
public static final DictionaryAttribute SEPARATOR
```
    Logical fields separator inside the FSA.
  - ENCODING
```
public static final DictionaryAttribute ENCODING
```
    Character to byte encoding used for strings inside the FSA.
  - USES_PREFIXES
```
public static final DictionaryAttribute USES_PREFIXES
```
    If the dictionary was compiled with prefix compression.
  - USES_INFIXES
```
public static final DictionaryAttribute USES_INFIXES
```
    If the dictionary was compiled with infix compression.
  - IGNORE_NUMBERS
```
public static final DictionaryAttribute IGNORE_NUMBERS
```
    If the spelling dictionary is supposed to ignore words containing digits
  - IGNORE_PUNCTUATION
```
public static final DictionaryAttribute IGNORE_PUNCTUATION
```
    If the spelling dictionary is supposed to ignore punctuation.
  - IGNORE_CAMEL_CASE
```
public static final DictionaryAttribute IGNORE_CAMEL_CASE
```
    If the spelling dictionary is supposed to ignore CamelCase words.
  - IGNORE_ALL_UPPERCASE
```
public static final DictionaryAttribute IGNORE_ALL_UPPERCASE
```
    If the spelling dictionary is supposed to ignore ALL UPPERCASE words.
  - IGNORE_DIACRITICS
```
public static final DictionaryAttribute IGNORE_DIACRITICS
```
    If the spelling dictionary is supposed to ignore diacritics, so that 'a' would be treated as equivalent to 'ą'.
  - CONVERT_CASE
```
public static final DictionaryAttribute CONVERT_CASE
```
    if the spelling dictionary is supposed to treat upper and lower case as equivalent.
  - RUN_ON_WORDS
```
public static final DictionaryAttribute RUN_ON_WORDS
```
    If the spelling dictionary is supposed to split runOnWords.
  - LOCALE
```
public static final DictionaryAttribute LOCALE
```
    Locale associated with the dictionary.
  - REPLACEMENT_PAIRS
```
public static final DictionaryAttribute REPLACEMENT_PAIRS
```
    Replacement pairs for non-obvious candidate search in a speller dictionary. For example, Polish rz is phonetically equivalent to ż, and this may be specified here to allow looking for replacements of rz with ż and vice versa.
  - EQUIVALENT_CHARS
```
public static final DictionaryAttribute EQUIVALENT_CHARS
```
    Equivalent characters (treated similarly as equivalent chars with and without diacritics). For example, Polish ł can be specified as equivalent to l.
    This implements a feature similar to hunspell MAP in the affix file.
  - LICENSE
```
public static final DictionaryAttribute LICENSE
```
    Dictionary license attribute.
  - AUTHOR
```
public static final DictionaryAttribute AUTHOR
```
    Dictionary author.
  - CREATION_DATE
```
public static final DictionaryAttribute CREATION_DATE
```
    Dictionary creation date.
- Field Detail
  - propertyName
```
public final java.lang.String propertyName
```
    Property name for this attribute.
- Method Detail
  - values
```
public static DictionaryAttribute[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DictionaryAttribute c : DictionaryAttribute.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DictionaryAttribute valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - fromString
```
public java.lang.Object fromString(java.lang.String value)
                            throws java.lang.IllegalArgumentException
```
    Converts a string to the given attribute's value (covariants used).
    
    Throws:
    
    java.lang.IllegalArgumentException - If the input string cannot be converted to the attribute's value.
  - fromPropertyName
```
public static DictionaryAttribute fromPropertyName(java.lang.String propertyName)
```
    Return an DictionaryAttribute by its propertyName.

Enum DictionaryAttribute

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SEPARATOR

ENCODING

USES_PREFIXES

USES_INFIXES

IGNORE_NUMBERS

IGNORE_PUNCTUATION

IGNORE_CAMEL_CASE

IGNORE_ALL_UPPERCASE

IGNORE_DIACRITICS

CONVERT_CASE

RUN_ON_WORDS

LOCALE

REPLACEMENT_PAIRS

EQUIVALENT_CHARS

LICENSE

AUTHOR

CREATION_DATE

Field Detail

propertyName

Method Detail

values

valueOf

fromString

fromPropertyName