Uses of Class
com.gengoai.hermes.AttributeType

Packages that use AttributeType

Package	Description
com.gengoai.hermes	Hermes is a framework for Natural Language Processing.
com.gengoai.hermes.annotator
com.gengoai.hermes.corpus
com.gengoai.hermes.extraction.lyre
com.gengoai.hermes.format.conll
com.gengoai.hermes.morphology

Uses of AttributeType in com.gengoai.hermes

Fields in com.gengoai.hermes declared as AttributeType

Modifier and Type	Field	Description
static AttributeType<String>	Types.AUTHOR	Attribute type defining the name (String) of the document's author
static AttributeType<String>	Types.CADUCEUS_RULE	Attribute added to extractions created by Caduceus to identify the name of the rule that created the extraction.
static AttributeType<Set<BasicCategories>>	Types.CATEGORY	Attribute defining the basic categories for a word/phrase.
static AttributeType<BasicCategories>	Types.CATEGORY_TAG	Special Attribute for loading BasicCategories lexicons
static AttributeType<Double>	Types.CONFIDENCE	Attribute defining the numeric confidence of an extraction.
static AttributeType<NDArray>	Types.EMBEDDING
static AttributeType<EntityType>	Types.ENTITY_TYPE	Attribute defining the type of entity for Entity annotations
static AttributeType<String>	Types.FILE	Attribute defining the file from which the document was created
static AttributeType<String>	Types.IMPORT_DATE
static AttributeType<Integer>	Types.INDEX	The index of a span with regards to a document
static AttributeType<Boolean>	Types.IS_NEGATED	Attributed specifying if a word/phrase is negated or not.
static AttributeType<List<String>>	Types.KEYWORDS	List of String attribute for defining a collection of keywords/phrases
static AttributeType<Language>	Types.LANGUAGE	Language attribute defining the language a specific span is written in
static AttributeType<String>	Types.LEMMA	Attribute defining the lemma of a word/phrase
static AttributeType<String>	Types.MATCHED_STRING	String attribute defining what was matched in a lexicon
static AttributeType<String>	Types.MATCHED_TAG	String attribute defining what tag was matched in a lexicon
static AttributeType<UniversalFeatureSet>	Types.MORPHOLOGICAL_FEATURES	Attribute defining the Morphological Features for a given span of text.
static AttributeType<PartOfSpeech>	Types.PART_OF_SPEECH	The part-of-speech associated with a span
static AttributeType<LocalDateTime>	Types.PUBLICATION_DATE	LocalDateTime attributed defining when a piece of content was published
static AttributeType<Double>	Types.SCORE
static AttributeType<String>	Types.SOURCE	String attribute defining the source of a document (e.g.
static AttributeType<String>	Types.SPELLING_CORRECTION	String attribute defining a correction to the spelling of the associated word/phrase.
static AttributeType<String>	Types.SPLIT
static AttributeType<String>	Types.STEM	String attribute denoting the stemmed version of the word/phrase.
static AttributeType<String>	Types.SYNTACTIC_FUNCTION	The functional part of a syntactic pos tag
static AttributeType<Tag>	Types.TAG	Tag attribute associated with the span.
static AttributeType<String>	Types.TITLE	String attribute defining the title of the document.
static AttributeType<TokenType>	Types.TOKEN_TYPE	TokenType attribute defining the type of token.
static AttributeType<String>	Types.TRANSLITERATION	String attribute defining a transliteration for a given word/phrase.
static AttributeType<Set<String>>	Types.WIKI_CATEGORIES	Set of String attribute defining the associated Wikipedia categories for a document or span of text.

Methods in com.gengoai.hermes that return AttributeType

Modifier and Type	Method	Description
static AttributeType<?>	Types.attribute(String name)	Attribute attribute type.
static <T> AttributeType<T>	Types.attribute(String name, Class<T> type)	Attribute attribute type.
static <T> AttributeType<T>	Types.attribute(String name, Type type)	Attribute attribute type.
AttributeType<Tag>	AnnotationType.getTagAttribute()
static <T> AttributeType<T>	AttributeType.make(String name)	Makes a new or retrieves an existing AttributeType with the given name
static <T> AttributeType<T>	AttributeType.make(String name, Class<? extends T> valueType)	Makes a new or retrieves an existing AttributeType with the given name
static <T> AttributeType<T>	AttributeType.make(String name, Type valueType)	Makes a new or retrieves an existing AttributeType with the given name
static <T> AttributeType<T>	AttributeType.valueOf(String name)	Returns the existing AttributeType for the given name throwing an exception if the type is not defined

Methods in com.gengoai.hermes that return types with arguments of type AttributeType

Modifier and Type	Method	Description
protected Registry<AttributeType<T>>	AttributeType.registry()
static Collection<AttributeType<?>>	AttributeType.values()

Methods in com.gengoai.hermes with parameters of type AttributeType

Modifier and Type	Method	Description
default <T> T	Annotation.attribute(@NonNull AttributeType<T> attributeType)
Document.AnnotationBuilder	Document.AnnotationBuilder.attribute(AttributeType type, Object value)	Sets the value of the given AttributeType on the new Annotation to the given value.
default <T> T	HString.attribute(@NonNull AttributeType<T> attributeType)	Gets the value for a given attribute type
default <T> T	HString.attribute(@NonNull AttributeType<T> attributeType, T defaultValue)	Gets the value for a given attribute type
default <T> boolean	HString.attributeEquals(@NonNull AttributeType<T> attributeType, Object targetValue)	Checks if the HString has an attribute of the given type that is equal to the given target value is used.
default <T> boolean	HString.attributeIsA(@NonNull AttributeType<T> attributeType, Object targetValue)	Checks if the HString has an attribute of the given type that is a instance of the given target value.
default <T> T	HString.computeIfAbsent(@NonNull AttributeType<T> attributeType, @NonNull Supplier<T> supplier)	Sets the value of an attribute if a value is not already set.
<T> T	AttributeMap.get(@NonNull AttributeType<T> attributeType)	Gets the value of the given attribute
<T> T	AttributeMap.getOrDefault(@NonNull AttributeType<T> attributeType, T defaultValue)	Gets the value of the given attribute or returns the default value if it is not in the map
default boolean	HString.hasAttribute(@NonNull AttributeType<?> attributeType)	Determines if an attribute of a given type is associated with the HString
static AnnotationType	AnnotationType.make(AnnotationType parent, String name, AttributeType<? extends Tag> tagAttributeType)	Makes a new or retrieves an existing AnnotationType with the given parent and name
static AnnotationType	AnnotationType.make(String name, AttributeType<? extends Tag> tagAttributeType)	Makes a new or retrieves an existing AnnotationType.
default <T> T	Annotation.put(@NonNull AttributeType<T> attributeType, T value)
Object	AttributeMap.put(@NonNull AttributeType attributeType, Object value)
default <T> T	HString.put(@NonNull AttributeType<T> attributeType, T value)	Sets the value of an attribute.
default <E,T extends Collection<E>> void	HString.putAdd(@NonNull AttributeType<T> attributeType, @NonNull Iterable<E> items)	Allows adding multiple values to a Collection based attribute.
default <T> T	HString.putIfAbsent(@NonNull AttributeType<T> attributeType, T value)	Sets the value of an attribute if a value is not already set.
default <T> T	HString.removeAttribute(@NonNull AttributeType<T> attributeType)	Removes an attribute from the HString.

Method parameters in com.gengoai.hermes with type arguments of type AttributeType

Modifier and Type	Method	Description
Document.AnnotationBuilder	Document.AnnotationBuilder.attributes(Map<AttributeType<?>,?> map)	Adds multiple attributes to the annotation
static Document	Document.create(@NonNull String text, @NonNull Language language, @NonNull Map<AttributeType<?>,?> attributes)	Convenience method for creating a document using the default document factory.
static Document	Document.create(@NonNull String id, @NonNull String text, @NonNull Language language, @NonNull Map<AttributeType<?>,?> attributes)	Convenience method for creating a document using the default document factory.
static Document	Document.create(@NonNull String id, @NonNull String text, @NonNull Map<AttributeType<?>,?> attributes)	Convenience method for creating a document using the default document factory.
static Document	Document.create(@NonNull String text, @NonNull Map<AttributeType<?>,?> attributes)	Convenience method for creating a document using the default document factory.
Document	DocumentFactory.create(@NonNull String content, @NonNull Language language, @NonNull Map<AttributeType<?>,?> attributeMap)	Creates a document with the given content written in the given language having the given set of attributes.
Document	DocumentFactory.create(@NonNull String id, @NonNull String content, @NonNull Language language, @NonNull Map<AttributeType<?>,?> attributeMap)	Creates a document with the given id and content written in the given language having the given set of attributes.
Annotation	Document.createAnnotation(AnnotationType type, int start, int end, Map<AttributeType<?>,?> attributeMap)	Creates an annotation of the given type encompassing the given span and having the given attributes.
Annotation	Document.createAnnotation(AnnotationType type, int start, int end, Map<AttributeType<?>,?> attributeMap, List<Relation> relations)	Creates an annotation of the given type encompassing the given span and having the given attributes.
Document	DocumentFactory.createRaw(@NonNull String content, @NonNull Language language, @NonNull Map<AttributeType<?>,?> attributeMap)	Creates a document with the given content written in the given language having the given set of attributes.
Document	DocumentFactory.createRaw(@NonNull String id, @NonNull String content, @NonNull Language language, @NonNull Map<AttributeType<?>,?> attributeMap)	Creates a document with the given id and content written in the given language having the given set of attributes.
void	AttributeMap.putAll(@NonNull Map<? extends AttributeType<?>,?> map)
default void	HString.putAll(@NonNull Map<AttributeType<?>,?> map)	Sets attributes on this HString from those in the given map.

Uses of AttributeType in com.gengoai.hermes.annotator

Constructors in com.gengoai.hermes.annotator with parameters of type AttributeType

Constructor	Description
FuzzyLexiconAnnotator(@NonNull AnnotationType annotationType, @NonNull AttributeType<?> attributeType, @NonNull Lexicon lexicon, @NonNull Language lexiconLanguage, int maxDistance)	Instantiates a new FuzzyLexiconAnnotator.
FuzzyLexiconAnnotator(@NonNull AnnotationType annotationType, @NonNull AttributeType<?> attributeType, @NonNull String lexiconName, @NonNull Language lexiconLanguage, int maxDistance)	Instantiates a new FuzzyLexiconAnnotator.

Uses of AttributeType in com.gengoai.hermes.corpus

Methods in com.gengoai.hermes.corpus that return types with arguments of type AttributeType

Modifier and Type	Method	Description
Set<AttributeType<?>>	Corpus.getAttributes()

Methods in com.gengoai.hermes.corpus with parameters of type AttributeType

Modifier and Type	Method	Description
<T> Counter<T>	Corpus.getAttributeValueCount(@NonNull AttributeType<T> type)	Gets a count of the values for the given attribute across documents in the corpus.

Uses of AttributeType in com.gengoai.hermes.extraction.lyre

Methods in com.gengoai.hermes.extraction.lyre with parameters of type AttributeType

Modifier and Type	Method	Description
static LyreExpression	LyreDSL.attribute(@NonNull AttributeType<?> type)	Returns the value of the given AttributeType on the current HString.
static LyreExpression	LyreDSL.attribute(@NonNull AttributeType<?> type, @NonNull LyreExpression expression)	Returns the value of the given AttributeType on the HString resulting from the given expression

Uses of AttributeType in com.gengoai.hermes.format.conll

Constructors in com.gengoai.hermes.format.conll with parameters of type AttributeType

Constructor	Description
IOBFieldProcessor(AnnotationType annotationType, AttributeType<?> attributeType)	Instantiates a new IOBFieldProcessor.

Uses of AttributeType in com.gengoai.hermes.morphology

Fields in com.gengoai.hermes.morphology with type parameters of type AttributeType

Modifier and Type	Field	Description
Map<AttributeType<?>,Object>	Tokenizer.Token.properties	The Properties.