Package com.basistech.rosette.dm

Class AnnotatedText.Builder

java.lang.Object

com.basistech.rosette.dm.AnnotatedText.Builder

Enclosing class:

AnnotatedText

public static class AnnotatedText.Builder
extends Object

Builder class for AnnotatedText objects.

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructs a builder.
Builder(AnnotatedText startingPoint)	Constructs a builder from an existing AnnotatedText.

Method Summary

Modifier and Type	Method	Description
Map<String,BaseAttribute>	attributes()	Returns the current attributes.
AnnotatedText.Builder	baseNounPhrases(ListAttribute<BaseNounPhrase> baseNounPhrases)	Attaches a list of base noun phrases.
AnnotatedText	build()	Constructs a AnnotatedText object from the settings in this builder.
AnnotatedText.Builder	categorizerResults(ListAttribute<CategorizerResult> categorizerResults)	Attaches a list of categorizer results.
AnnotatedText.Builder	concepts(ListAttribute<Concept> concepts)
CharSequence	data()	Returns the current character data.
AnnotatedText.Builder	data(CharSequence data)	Constructs a builder over some character data.
AnnotatedText.Builder	dependencies(ListAttribute<Dependency> dependencies)	Attaches a list of dependencies.
Map<String,List<String>>	documentMetadata()	Returns the current document metadata.
AnnotatedText.Builder	documentMetadata(String key, String value)	Adds an entry to the document metadata.
AnnotatedText.Builder	documentMetadata(String key, List<String> value)	Adds an entry to the document metadata.
AnnotatedText.Builder	documentMetadata(Map<String,List<String>> mapOfValues)	Add all of the contents of a map of metadata to the document metadata.
AnnotatedText.Builder	embeddings(Embeddings embeddings)	Attaches a set of embeddings.
AnnotatedText.Builder	entities(ListAttribute<Entity> entities)	Attaches a list of entities.
AnnotatedText.Builder	entityMentions(ListAttribute<EntityMention> entityMentions)	Deprecated. Use entities(ListAttribute).
AnnotatedText.Builder	events(ListAttribute<Event> events)	Attaches a list of events.
AnnotatedText.Builder	keyphrases(ListAttribute<Keyphrase> keyphrases)
AnnotatedText.Builder	languageDetectionRegions(ListAttribute<LanguageDetection> languageDetectionRegions)	Attaches a list of language detections.
AnnotatedText.Builder	layoutRegions(ListAttribute<LayoutRegion> layoutRegions)	Attaches a list of layout regions.
AnnotatedText.Builder	relationshipMentions(ListAttribute<RelationshipMention> relationshipMentions)	Attaches a list of relationship mentions.
AnnotatedText.Builder	resolvedEntities(ListAttribute<ResolvedEntity> resolvedEntities)	Deprecated. use entities(ListAttribute).
AnnotatedText.Builder	scriptRegions(ListAttribute<ScriptRegion> scriptRegions)	Attaches a list of script regions.
AnnotatedText.Builder	sentences(ListAttribute<Sentence> sentences)	Attaches a list of sentences.
AnnotatedText.Builder	sentimentResults(ListAttribute<CategorizerResult> sentimentResults)	Attaches a list of sentiment results.
AnnotatedText.Builder	similarTerms(MapAttribute<com.basistech.util.LanguageCode,ListAttribute<SimilarTerm>> similarTerms)	Attaches a per-language map of similar terms.
AnnotatedText.Builder	tokens(ListAttribute<Token> tokens)	Attaches a list of tokens.
AnnotatedText.Builder	topicResults(ListAttribute<CategorizerResult> topicResults)
AnnotatedText.Builder	translatedData(ListAttribute<TranslatedData> translatedData)	Attaches a TranslatedData object.
AnnotatedText.Builder	translatedTokens(ListAttribute<TranslatedTokens> translatedTokens)	Attaches a list of TranslatedTokens objects.
AnnotatedText.Builder	transliteration(TransliterationResults transliterationResults)
AnnotatedText.Builder	wholeDocumentLanguageDetection(LanguageDetection languageDetection)	Attaches a whole-document language detection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Constructs a builder. The initial data is the empty string.

Builder

public Builder(AnnotatedText startingPoint)

Constructs a builder from an existing AnnotatedText.

Parameters:

startingPoint - source object to copy

Method Details

data

public AnnotatedText.Builder data(CharSequence data)

Constructs a builder over some character data.

Parameters:

data - the data. This replaces and previous setting.

Returns:

this

data

public CharSequence data()

Returns the current character data.

Returns:

the current character data

baseNounPhrases

public AnnotatedText.Builder baseNounPhrases(ListAttribute<BaseNounPhrase> baseNounPhrases)

Attaches a list of base noun phrases.

Parameters:

baseNounPhrases - the base noun phrases

Returns:

this

entityMentions

@Deprecated
public AnnotatedText.Builder entityMentions(ListAttribute<EntityMention> entityMentions)

Deprecated.

Use entities(ListAttribute).

Attaches a list of entity mentions.

Parameters:

entityMentions - the entity mentions

Returns:

this

similarTerms

public AnnotatedText.Builder similarTerms(MapAttribute<com.basistech.util.LanguageCode,ListAttribute<SimilarTerm>> similarTerms)

Attaches a per-language map of similar terms.

Parameters:

similarTerms - the similar terms

Returns:

this

relationshipMentions

public AnnotatedText.Builder relationshipMentions(ListAttribute<RelationshipMention> relationshipMentions)

Attaches a list of relationship mentions.

Parameters:

relationshipMentions - the relationship mentions.

Returns:

this

entities

public AnnotatedText.Builder entities(ListAttribute<Entity> entities)

Attaches a list of entities.

Parameters:

entities - the entities.

Returns:

this.

resolvedEntities

@Deprecated
public AnnotatedText.Builder resolvedEntities(ListAttribute<ResolvedEntity> resolvedEntities)

Deprecated.

use entities(ListAttribute).

Attaches a list of resolved entities.

Parameters:

resolvedEntities - the resolved entities

Returns:

this

events

public AnnotatedText.Builder events(ListAttribute<Event> events)

Attaches a list of events.

Parameters:

events - events

Returns:

this

languageDetectionRegions

public AnnotatedText.Builder languageDetectionRegions(ListAttribute<LanguageDetection> languageDetectionRegions)

Attaches a list of language detections.

Parameters:

languageDetectionRegions - the language detections

Returns:

this

wholeDocumentLanguageDetection

public AnnotatedText.Builder wholeDocumentLanguageDetection(LanguageDetection languageDetection)

Attaches a whole-document language detection.

Parameters:

languageDetection - the language detection

Returns:

this

scriptRegions

public AnnotatedText.Builder scriptRegions(ListAttribute<ScriptRegion> scriptRegions)

Attaches a list of script regions.

Parameters:

scriptRegions - the script regions

Returns:

this

sentences

public AnnotatedText.Builder sentences(ListAttribute<Sentence> sentences)

Attaches a list of sentences.

Parameters:

sentences - the sentences

Returns:

this

layoutRegions

public AnnotatedText.Builder layoutRegions(ListAttribute<LayoutRegion> layoutRegions)

Attaches a list of layout regions.

Parameters:

layoutRegions - the layout regions

Returns:

this

tokens

public AnnotatedText.Builder tokens(ListAttribute<Token> tokens)

Attaches a list of tokens.

Parameters:

tokens - the tokens

Returns:

this

translatedTokens

public AnnotatedText.Builder translatedTokens(ListAttribute<TranslatedTokens> translatedTokens)

Attaches a list of TranslatedTokens objects.

Parameters:

translatedTokens - a list of TranslatedTokens objects

Returns:

this

translatedData

public AnnotatedText.Builder translatedData(ListAttribute<TranslatedData> translatedData)

Attaches a TranslatedData object.

Parameters:

translatedData - a TranslatedData object

Returns:

this

categorizerResults

public AnnotatedText.Builder categorizerResults(ListAttribute<CategorizerResult> categorizerResults)

Attaches a list of categorizer results.

Parameters:

categorizerResults - the categorizer results

Returns:

this

sentimentResults

public AnnotatedText.Builder sentimentResults(ListAttribute<CategorizerResult> sentimentResults)

Attaches a list of sentiment results.

Parameters:

sentimentResults - the sentiment results

Returns:

this

dependencies

public AnnotatedText.Builder dependencies(ListAttribute<Dependency> dependencies)

Attaches a list of dependencies.

Parameters:

dependencies - the dependencies.

Returns:

this

topicResults

public AnnotatedText.Builder topicResults(ListAttribute<CategorizerResult> topicResults)

embeddings

public AnnotatedText.Builder embeddings(Embeddings embeddings)

Attaches a set of embeddings.

Parameters:

embeddings - the embeddings.

Returns:

this.

concepts

public AnnotatedText.Builder concepts(ListAttribute<Concept> concepts)

keyphrases

public AnnotatedText.Builder keyphrases(ListAttribute<Keyphrase> keyphrases)

transliteration

public AnnotatedText.Builder transliteration(TransliterationResults transliterationResults)

attributes

public Map<String,BaseAttribute> attributes()

Returns the current attributes.

Returns:

the current attributes

documentMetadata

public AnnotatedText.Builder documentMetadata(String key,
 List<String> value)

Adds an entry to the document metadata. Replaces any previous value for this key.

Parameters:

key - key

value - value

Returns:

this

documentMetadata

public AnnotatedText.Builder documentMetadata(Map<String,List<String>> mapOfValues)

Add all of the contents of a map of metadata to the document metadata.

Parameters:

mapOfValues - a map from keys to values.

Returns:

this

documentMetadata

public AnnotatedText.Builder documentMetadata(String key,
 String value)

Adds an entry to the document metadata. Replaces any previous value for this key.

Parameters:

key - key

value - A single string value. The result of this call is to store a list containing this value as the value for this key.

Returns:

this

documentMetadata

public Map<String,List<String>> documentMetadata()

Returns the current document metadata.

Returns:

the current document metadata

build

public AnnotatedText build()

Constructs a AnnotatedText object from the settings in this builder.

Returns:

the new object