```
public interface Types
```
Common Annotatable Types. The predefined types are pre-loaded on initialization.

Author:

David B. Bracewell

Field Summary

Fields
Modifier and Type	Field	Description
`static AttributeType<String>`	`AUTHOR`	Attribute type defining the name (String) of the document's author
`static AnnotatableType[]`	`BASE_ANNOTATIONS`
`static AttributeType<String>`	`CADUCEUS_RULE`	Attribute added to extractions created by Caduceus to identify the name of the rule that created the extraction.
`static AttributeType<Set<BasicCategories>>`	`CATEGORY`	Attribute defining the basic categories for a word/phrase.
`static AttributeType<BasicCategories>`	`CATEGORY_TAG`	Special Attribute for loading BasicCategories lexicons
`static AttributeType<Double>`	`CONFIDENCE`	Attribute defining the numeric confidence of an extraction.
`static AnnotationType`	`CONSTITUENT_PARSE`	AnnotationType denoting that a constituent parse has be performed.
`static RelationType`	`DEPENDENCY`	RelationType defining dependency relations.
`static AttributeType<NDArray>`	`EMBEDDING`
`static AnnotationType`	`ENTITY`	Entity annotation type
`static AttributeType<EntityType>`	`ENTITY_TYPE`	Attribute defining the type of entity for Entity annotations
`static AttributeType<String>`	`FILE`	Attribute defining the file from which the document was created
`static AttributeType<String>`	`IMPORT_DATE`
`static AttributeType<Integer>`	`INDEX`	The index of a span with regards to a document
`static AttributeType<Boolean>`	`IS_NEGATED`	Attributed specifying if a word/phrase is negated or not.
`static AttributeType<List<String>>`	`KEYWORDS`	List of String attribute for defining a collection of keywords/phrases
`static AttributeType<Language>`	`LANGUAGE`	Language attribute defining the language a specific span is written in
`static AttributeType<String>`	`LEMMA`	Attribute defining the lemma of a word/phrase
`static AnnotationType`	`LEXICON_MATCH`	AnnotationType for lexicon matches
`static AttributeType<String>`	`MATCHED_STRING`	String attribute defining what was matched in a lexicon
`static AttributeType<String>`	`MATCHED_TAG`	String attribute defining what tag was matched in a lexicon
`static AnnotationType`	`ML_ENTITY`	Machine learning provided Entities
`static AttributeType<UniversalFeatureSet>`	`MORPHOLOGICAL_FEATURES`	Attribute defining the Morphological Features for a given span of text.
`static AnnotationType`	`MWE`	Multi-word expression annotations
`static AnnotationType`	`NON_TERMINAL_NODE`	Non-Terminal node in a constituency parse
`static AttributeType<PartOfSpeech>`	`PART_OF_SPEECH`	The part-of-speech associated with a span
`static AnnotationType`	`PHRASE_CHUNK`	Phrase Chunk annotation type
`static AttributeType<LocalDateTime>`	`PUBLICATION_DATE`	LocalDateTime attributed defining when a piece of content was published
`static AttributeType<Double>`	`SCORE`
`static AnnotationType`	`SENTENCE`	Sentence annotation type
`static AttributeType<String>`	`SOURCE`	String attribute defining the source of a document (e.g.
`static AttributeType<String>`	`SPELLING_CORRECTION`	String attribute defining a correction to the spelling of the associated word/phrase.
`static AttributeType<String>`	`SPLIT`
`static AttributeType<String>`	`STEM`	String attribute denoting the stemmed version of the word/phrase.
`static AttributeType<String>`	`SYNTACTIC_FUNCTION`	The functional part of a syntactic pos tag
`static RelationType`	`SYNTACTIC_HEAD`	Relation type denoting that the target is the syntactic head of the source
`static AttributeType<Tag>`	`TAG`	Tag attribute associated with the span.
`static AttributeType<String>`	`TITLE`	String attribute defining the title of the document.
`static AnnotationType`	`TOKEN`	Token annotation type
`static AttributeType<TokenType>`	`TOKEN_TYPE`	TokenType attribute defining the type of token.
`static AnnotationType`	`TOKEN_TYPE_ENTITY`	AnnotationType for Entities identified using TokenTypes.
`static AttributeType<String>`	`TRANSLITERATION`	String attribute defining a transliteration for a given word/phrase.
`static AttributeType<Set<String>>`	`WIKI_CATEGORIES`	Set of String attribute defining the associated Wikipedia categories for a document or span of text.
`static AnnotationType`	`WORD_SENSE`

Method Summary

Static Methods
Modifier and Type	Method	Description
`static AnnotationType`	`annotation(String name)`	Annotation annotation type.
`static AttributeType<?>`	`attribute(String name)`	Attribute attribute type.
`static <T> AttributeType<T>`	`attribute(String name, Class<T> type)`	Attribute attribute type.
`static <T> AttributeType<T>`	`attribute(String name, Type type)`	Attribute attribute type.
`static RelationType`	`relation(String name)`	Relation relation type.
`static String`	`toName(@NonNull String type, @NonNull String name)`	To name string.
`static String`	`toTypeName(@NonNull String type, @NonNull String name)`	To type name string.

- Field Detail
  - AUTHOR
```
static final AttributeType<String> AUTHOR
```
    Attribute type defining the name (String) of the document's author
  - CADUCEUS_RULE
```
static final AttributeType<String> CADUCEUS_RULE
```
    Attribute added to extractions created by Caduceus to identify the name of the rule that created the extraction.
  - CATEGORY
```
static final AttributeType<Set<BasicCategories>> CATEGORY
```
    Attribute defining the basic categories for a word/phrase.
  - CATEGORY_TAG
```
static final AttributeType<BasicCategories> CATEGORY_TAG
```
    Special Attribute for loading BasicCategories lexicons
  - CONFIDENCE
```
static final AttributeType<Double> CONFIDENCE
```
    Attribute defining the numeric confidence of an extraction.
  - CONSTITUENT_PARSE
```
static final AnnotationType CONSTITUENT_PARSE
```
    AnnotationType denoting that a constituent parse has be performed. Note that no annotations of this type are added, but instead NON_TERMINAL_NODE annotation and, SYNTACTIC_HEAD relations are.
  - DEPENDENCY
```
static final RelationType DEPENDENCY
```
    RelationType defining dependency relations.
  - EMBEDDING
```
static final AttributeType<NDArray> EMBEDDING
```
  - ENTITY_TYPE
```
static final AttributeType<EntityType> ENTITY_TYPE
```
    Attribute defining the type of entity for Entity annotations
  - ENTITY
```
static final AnnotationType ENTITY
```
    Entity annotation type
  - FILE
```
static final AttributeType<String> FILE
```
    Attribute defining the file from which the document was created
  - IMPORT_DATE
```
static final AttributeType<String> IMPORT_DATE
```
  - INDEX
```
static final AttributeType<Integer> INDEX
```
    The index of a span with regards to a document
  - IS_NEGATED
```
static final AttributeType<Boolean> IS_NEGATED
```
    Attributed specifying if a word/phrase is negated or not.
  - KEYWORDS
```
static final AttributeType<List<String>> KEYWORDS
```
    List of String attribute for defining a collection of keywords/phrases
  - LANGUAGE
```
static final AttributeType<Language> LANGUAGE
```
    Language attribute defining the language a specific span is written in
  - LEMMA
```
static final AttributeType<String> LEMMA
```
    Attribute defining the lemma of a word/phrase
  - LEXICON_MATCH
```
static final AnnotationType LEXICON_MATCH
```
    AnnotationType for lexicon matches
  - MATCHED_STRING
```
static final AttributeType<String> MATCHED_STRING
```
    String attribute defining what was matched in a lexicon
  - MATCHED_TAG
```
static final AttributeType<String> MATCHED_TAG
```
    String attribute defining what tag was matched in a lexicon
  - ML_ENTITY
```
static final AnnotationType ML_ENTITY
```
    Machine learning provided Entities
  - MORPHOLOGICAL_FEATURES
```
static final AttributeType<UniversalFeatureSet> MORPHOLOGICAL_FEATURES
```
    Attribute defining the Morphological Features for a given span of text.
  - PART_OF_SPEECH
```
static final AttributeType<PartOfSpeech> PART_OF_SPEECH
```
    The part-of-speech associated with a span
  - NON_TERMINAL_NODE
```
static final AnnotationType NON_TERMINAL_NODE
```
    Non-Terminal node in a constituency parse
  - PHRASE_CHUNK
```
static final AnnotationType PHRASE_CHUNK
```
    Phrase Chunk annotation type
  - PUBLICATION_DATE
```
static final AttributeType<LocalDateTime> PUBLICATION_DATE
```
    LocalDateTime attributed defining when a piece of content was published
  - SCORE
```
static final AttributeType<Double> SCORE
```
  - SENTENCE
```
static final AnnotationType SENTENCE
```
    Sentence annotation type
  - SOURCE
```
static final AttributeType<String> SOURCE
```
    String attribute defining the source of a document (e.g. url, name of news agency, etc.)
  - SPELLING_CORRECTION
```
static final AttributeType<String> SPELLING_CORRECTION
```
    String attribute defining a correction to the spelling of the associated word/phrase.
  - SPLIT
```
static final AttributeType<String> SPLIT
```
  - STEM
```
static final AttributeType<String> STEM
```
    String attribute denoting the stemmed version of the word/phrase.
  - SYNTACTIC_FUNCTION
```
static final AttributeType<String> SYNTACTIC_FUNCTION
```
    The functional part of a syntactic pos tag
  - SYNTACTIC_HEAD
```
static final RelationType SYNTACTIC_HEAD
```
    Relation type denoting that the target is the syntactic head of the source
  - TAG
```
static final AttributeType<Tag> TAG
```
    Tag attribute associated with the span.
  - MWE
```
static final AnnotationType MWE
```
    Multi-word expression annotations
  - TITLE
```
static final AttributeType<String> TITLE
```
    String attribute defining the title of the document.
  - TOKEN
```
static final AnnotationType TOKEN
```
    Token annotation type
  - BASE_ANNOTATIONS
```
static final AnnotatableType[] BASE_ANNOTATIONS
```
  - TOKEN_TYPE
```
static final AttributeType<TokenType> TOKEN_TYPE
```
    TokenType attribute defining the type of token.
  - TOKEN_TYPE_ENTITY
```
static final AnnotationType TOKEN_TYPE_ENTITY
```
    AnnotationType for Entities identified using TokenTypes.
  - TRANSLITERATION
```
static final AttributeType<String> TRANSLITERATION
```
    String attribute defining a transliteration for a given word/phrase.
  - WIKI_CATEGORIES
```
static final AttributeType<Set<String>> WIKI_CATEGORIES
```
    Set of String attribute defining the associated Wikipedia categories for a document or span of text.
  - WORD_SENSE
```
static final AnnotationType WORD_SENSE
```
- Method Detail
  - annotation
```
static AnnotationType annotation(String name)
```
    Annotation annotation type.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the annotation type
  - attribute
```
static AttributeType<?> attribute(String name)
```
    Attribute attribute type.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the attribute type
  - attribute
```
static <T> AttributeType<T> attribute(String name,
                                      Type type)
```
    Attribute attribute type.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    name - the name
    
    type - the type
    
    Returns:
    
    the attribute type
  - attribute
```
static <T> AttributeType<T> attribute(String name,
                                      Class<T> type)
```
    Attribute attribute type.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    name - the name
    
    type - the type
    
    Returns:
    
    the attribute type
  - relation
```
static RelationType relation(String name)
```
    Relation relation type.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the relation type
  - toName
```
static String toName(@NonNull
                     @NonNull String type,
                     @NonNull
                     @NonNull String name)
```
    To name string.
    
    Parameters:
    
    type - the type
    
    name - the name
    
    Returns:
    
    the string
  - toTypeName
```
static String toTypeName(@NonNull
                         @NonNull String type,
                         @NonNull
                         @NonNull String name)
```
    To type name string.
    
    Parameters:
    
    type - the type
    
    name - the name
    
    Returns:
    
    the string

Interface Types

Field Summary

Method Summary

Field Detail

AUTHOR

CADUCEUS_RULE

CATEGORY

CATEGORY_TAG

CONFIDENCE

CONSTITUENT_PARSE

DEPENDENCY

EMBEDDING

ENTITY_TYPE

ENTITY

FILE

IMPORT_DATE

INDEX

IS_NEGATED

KEYWORDS

LANGUAGE

LEMMA

LEXICON_MATCH

MATCHED_STRING

MATCHED_TAG

ML_ENTITY

MORPHOLOGICAL_FEATURES

PART_OF_SPEECH

NON_TERMINAL_NODE

PHRASE_CHUNK

PUBLICATION_DATE

SCORE

SENTENCE

SOURCE

SPELLING_CORRECTION

SPLIT

STEM

SYNTACTIC_FUNCTION

SYNTACTIC_HEAD

TAG

MWE

TITLE

TOKEN

BASE_ANNOTATIONS

TOKEN_TYPE

TOKEN_TYPE_ENTITY

TRANSLITERATION

WIKI_CATEGORIES

WORD_SENSE

Method Detail

annotation

attribute

attribute

attribute

relation

toName

toTypeName