SALT_TYPE (salt-api 3.0.5 API)

java.lang.Object
- java.lang.Enum<SALT_TYPE>
- - org.corpus_tools.salt.SALT_TYPE

All Implemented Interfaces:

Serializable, Comparable<SALT_TYPE>
```
public enum SALT_TYPE
extends Enum<SALT_TYPE>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`SCORPUS`
`SDOCUMENT`
`SDOMINANCE_RELATION`
`SMEDIAL_DS`
`SMEDIAL_RELATION`
`SORDER_RELATION`
`SPOINTING_RELATION`
`SSEQUENTIAL_DS`
`SSEQUENTIAL_RELATION`
`SSPAN`
`SSPANNING_RELATION`
`SSTRUCTURE`
`STEXT_OVERLAPPING_RELATION`
`STEXTUAL_DS`
`STEXTUAL_RELATION`
`STIME_OVERLAPPING_RELATION`
`STIMELINE_RELATION`
`STOKEN`

Method Summary

Methods
Modifier and Type	Method and Description
`static Set<SALT_TYPE>`	`class2SaltType(Class<? extends Object>... classes)` Converts the given class, if it is a class of the Salt model into its corresponding `SALT_TYPE`.
`Class<?>`	`getJavaType()`
`protected static Map<SALT_TYPE,Class<? extends Object>>`	`getSType2clazz()` Returns map of `SALT_TYPE` and `Class`.
`static SALT_TYPE`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SALT_TYPE[]`	`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
  - STEXTUAL_DS
```
public static final SALT_TYPE STEXTUAL_DS
```
  - SSEQUENTIAL_DS
```
public static final SALT_TYPE SSEQUENTIAL_DS
```
  - SMEDIAL_DS
```
public static final SALT_TYPE SMEDIAL_DS
```
  - STOKEN
```
public static final SALT_TYPE STOKEN
```
  - SSPAN
```
public static final SALT_TYPE SSPAN
```
  - SSTRUCTURE
```
public static final SALT_TYPE SSTRUCTURE
```
  - STEXTUAL_RELATION
```
public static final SALT_TYPE STEXTUAL_RELATION
```
  - STIMELINE_RELATION
```
public static final SALT_TYPE STIMELINE_RELATION
```
  - SMEDIAL_RELATION
```
public static final SALT_TYPE SMEDIAL_RELATION
```
  - SSPANNING_RELATION
```
public static final SALT_TYPE SSPANNING_RELATION
```
  - SDOMINANCE_RELATION
```
public static final SALT_TYPE SDOMINANCE_RELATION
```
  - SPOINTING_RELATION
```
public static final SALT_TYPE SPOINTING_RELATION
```
  - STEXT_OVERLAPPING_RELATION
```
public static final SALT_TYPE STEXT_OVERLAPPING_RELATION
```
  - STIME_OVERLAPPING_RELATION
```
public static final SALT_TYPE STIME_OVERLAPPING_RELATION
```
  - SSEQUENTIAL_RELATION
```
public static final SALT_TYPE SSEQUENTIAL_RELATION
```
  - SORDER_RELATION
```
public static final SALT_TYPE SORDER_RELATION
```
  - SDOCUMENT
```
public static final SALT_TYPE SDOCUMENT
```
  - SCORPUS
```
public static final SALT_TYPE SCORPUS
```
- Method Detail
  - values
```
public static SALT_TYPE[] 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 (SALT_TYPE c : SALT_TYPE.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SALT_TYPE valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getJavaType
```
public Class<?> getJavaType()
```
    Returns:
    the java class which represents this Salt type
  - getSType2clazz
```
protected static Map<SALT_TYPE,Class<? extends Object>> getSType2clazz()
```
    Returns map of SALT_TYPE and Class.
    
    Returns:
    a map of SALT_TYPE and the corresponding class in Salt
  - class2SaltType
```
public static Set<SALT_TYPE> class2SaltType(Class<? extends Object>... classes)
```
    Converts the given class, if it is a class of the Salt model into its corresponding SALT_TYPE.
    
    Parameters:
    classes - to convert
    
    Returns:
    SALT_TYPE of passed class

Enum SALT_TYPE

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

STEXTUAL_DS

SSEQUENTIAL_DS

SMEDIAL_DS

STOKEN

SSPAN

SSTRUCTURE

STEXTUAL_RELATION

STIMELINE_RELATION

SMEDIAL_RELATION

SSPANNING_RELATION

SDOMINANCE_RELATION

SPOINTING_RELATION

STEXT_OVERLAPPING_RELATION

STIME_OVERLAPPING_RELATION

SSEQUENTIAL_RELATION

SORDER_RELATION

SDOCUMENT

SCORPUS

Method Detail

values

valueOf

getJavaType

getSType2clazz

class2SaltType