RelationType (com.gengoai:hermes 1.1-SNAPSHOT API)

java.lang.Object
- com.gengoai.EnumValue<RelationType>
- - com.gengoai.hermes.RelationType

All Implemented Interfaces:

AnnotatableType, Tag, Serializable, Cloneable, Comparable<RelationType>
```
public final class RelationType
extends EnumValue<RelationType>
implements AnnotatableType
```
Dynamic enumeration of known types of relations that can exist between annotations. Relations represent edges between two annotations. Examples include syntactic (dependency parse) and semantic (semantic roles) relations.

Author:

David B. Bracewell

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.gengoai.hermes.AnnotatableType
  AnnotatableType.Deserializer, AnnotatableType.KeyDeserializer, AnnotatableType.Serializer

Field Summary

Fields
Modifier and Type Field Description

static String TYPE
The constant TYPE.
- Fields inherited from interface com.gengoai.hermes.AnnotatableType
  ANNOTATOR_PACKAGE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static boolean`	`isDefined(String name)`	Is defined boolean.
`static RelationType`	`make(String name)`	Makes a new or retrieves an existing RelationType with the given name
`protected Registry<RelationType>`	`registry()`
`String`	`type()`
`static RelationType`	`valueOf(String name)`	Value of relation type.
`static Collection<RelationType>`	`values()`	Returns a collection of all known RelationType in the enumeration.

Methods inherited from class com.gengoai.EnumValue
canonicalName, clone, compareTo, equals, hashCode, isInstance, main, name, readResolve, toString

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

Methods inherited from interface com.gengoai.hermes.AnnotatableType
canonicalName, getAnnotator, name

Methods inherited from interface com.gengoai.Tag
isInstance, label, parent

- Field Detail
  - TYPE
```
public static final String TYPE
```
    The constant TYPE.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isDefined
```
public static boolean isDefined(String name)
```
    Is defined boolean.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the boolean
  - make
```
public static RelationType make(String name)
```
    Makes a new or retrieves an existing RelationType with the given name
    
    Parameters:
    
    name - the name of the RelationType
    
    Returns:
    
    the RelationType
  - valueOf
```
public static RelationType valueOf(String name)
```
    Value of relation type.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the relation type
  - values
```
public static Collection<RelationType> values()
```
    Returns a collection of all known RelationType in the enumeration.
    
    Returns:
    
    the collection of known RelationType
  - registry
```
protected Registry<RelationType> registry()
```
    Specified by:
    
    registry in class EnumValue<RelationType>
  - type
```
public String type()
```
    Specified by:
    
    type in interface AnnotatableType
    
    Returns:
    
    The type (Annotation, Attribute, Relation)