Index

A B C D E F G I L M N O P Q R S T V W 
All Classes All Packages

A

AddLabelFilter(String, String, String) - Method in interface com.lexalytics.salience.ISalience
 
AddLabelFilter(String, String, String) - Method in class com.lexalytics.salience.Salience
Add a basic label filter.
addSalienceConfiguration(String, String) - Method in interface com.lexalytics.salience.ISalience
 
addSalienceConfiguration(String, String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
addSalienceConfiguration(String, String) - Method in class com.lexalytics.salience.Salience
Add a user directory session.
addSalienceConfiguration(String, String) - Method in class com.lexalytics.salience.SalienceCollections
Add a user directory session.
addSection(String, String, boolean) - Method in interface com.lexalytics.salience.ISalience
 
addSection(String, String, boolean) - Method in class com.lexalytics.salience.Salience
Adds the supplied document into a section for analysis.
addSectionFromFile(String, String, boolean) - Method in interface com.lexalytics.salience.ISalience
 
addSectionFromFile(String, String, boolean) - Method in class com.lexalytics.salience.Salience
Adds a document from disk into a section for analysis.
AddSentimentDictionary(String) - Method in class com.lexalytics.salience.Options.SentimentOptions
Appends another sentiment dictionary (HSD) containing phrases to consider in sentiment analysis.
AddSentimentModel(String) - Method in class com.lexalytics.salience.Options.SentimentOptions
Specifies a sentiment model to use for model-based sentiment analysis.
AddSentimentRule(String, float, String) - Method in interface com.lexalytics.salience.ISalience
 
AddSentimentRule(String, float, String) - Method in class com.lexalytics.salience.Salience
Add a basic sentiment rule.
AddSentimentRule(String, String, String) - Method in interface com.lexalytics.salience.ISalience
 
AddSentimentRule(String, String, String) - Method in class com.lexalytics.salience.Salience
Add a basic sentiment rule.
AlternateTheme - Class in com.lexalytics.salience
An alternate theme ...
AlternateTheme(String, float) - Constructor for class com.lexalytics.salience.AlternateTheme
Creates a new alternate theme.
ApplyFilters(String, String) - Method in interface com.lexalytics.salience.ISalience
 
ApplyFilters(String, String) - Method in class com.lexalytics.salience.Salience
Apply a basic label filter.
Attribute - Class in com.lexalytics.salience
An Attribute object represents a noun or adjective phrase connected to the Facet of a document.
Attribute(String, int, int, int, int, Vector<Phrase>, Vector<Phrase>, Vector<Phrase>, Vector<Phrase>) - Constructor for class com.lexalytics.salience.Attribute
Creates a new attribute.

B

Base - Variable in class com.lexalytics.salience.Options
 
BaseOptions() - Constructor for class com.lexalytics.salience.Options.BaseOptions
 
BasicLabel - Class in com.lexalytics.salience
A BasicLabel represents a basic language label.
BasicLabel(String) - Constructor for class com.lexalytics.salience.BasicLabel
Creates a new basic label.
BasicLanguage - Variable in class com.lexalytics.salience.Options
 
BasicLanguageOptions() - Constructor for class com.lexalytics.salience.Options.BasicLanguageOptions
 
BasicSentimentRule - Class in com.lexalytics.salience
A BasicSentimentRule represents a basic language sentiment rule.
BasicSentimentRule(String, String, String) - Constructor for class com.lexalytics.salience.BasicSentimentRule
Creates a new basic sentiment rule.

C

call(int, String) - Method in class com.lexalytics.salience.SalienceCallback
Specifies a method that can receive callback messages from the underlying API.
Categories - Variable in class com.lexalytics.salience.Options
 
CategoryOptions() - Constructor for class com.lexalytics.salience.Options.CategoryOptions
 
Chunk - Class in com.lexalytics.salience
A Chunk object represents a section of the text, generally a sentence fragment.
Chunk(Vector<ChunkToken>, String, int, float) - Constructor for class com.lexalytics.salience.Chunk
Creates a new chunk.
ChunkToken - Class in com.lexalytics.salience
A ChunkToken object represents a token from a Chunk object.
ChunkToken(String, String, boolean, String, int, int, int, int) - Constructor for class com.lexalytics.salience.ChunkToken
Creates a new chunk token.
ClassificationOptions() - Constructor for class com.lexalytics.salience.Options.ClassificationOptions
 
Classifications - Variable in class com.lexalytics.salience.Options
 
ClearSentimentModels() - Method in class com.lexalytics.salience.Options.SentimentOptions
Clears all current sentiment models from model-based sentiment analysis.
CollectionDetails - Class in com.lexalytics.salience
A CollectionDetails object provides the statistical information about the collection content determined by Salience.
CollectionDetails(int) - Constructor for class com.lexalytics.salience.CollectionDetails
Creates a new CollectionDetails object.
CollectionEntity - Class in com.lexalytics.salience
A CollectionEntity object represents an Entity that has been extracted from a collection document.
CollectionEntity(Vector<Phrase>, String, String, String, int, int, int, int) - Constructor for class com.lexalytics.salience.CollectionEntity
Creates a new collection entity.
CollectionOptions() - Constructor for class com.lexalytics.salience.Options.CollectionOptions
 
Collections - Variable in class com.lexalytics.salience.Options
 
com.lexalytics.salience - package com.lexalytics.salience
 
ConceptOptions() - Constructor for class com.lexalytics.salience.Options.ConceptOptions
 
Concepts - Variable in class com.lexalytics.salience.Options
 
CorrectOCRErrors(Vector<OCRCharacterAttribute>, float) - Method in interface com.lexalytics.salience.ISalience
 
CorrectOCRErrors(Vector<OCRCharacterAttribute>, float) - Method in class com.lexalytics.salience.Salience
Corrects likely OCR errors found in prepared text.

D

DeleteLabelFilter(String, String) - Method in interface com.lexalytics.salience.ISalience
 
DeleteLabelFilter(String, String) - Method in class com.lexalytics.salience.Salience
Delete a basic label filter.
DeleteSentimentRule(String, String) - Method in interface com.lexalytics.salience.ISalience
 
DeleteSentimentRule(String, String) - Method in class com.lexalytics.salience.Salience
Delete a sentment rule in the given configuration.
disableCallback(boolean) - Method in interface com.lexalytics.salience.ISalience
 
disableCallback(boolean) - Method in interface com.lexalytics.salience.ISalienceCollections
 
disableCallback(boolean) - Method in class com.lexalytics.salience.Salience
Enables or disables callback messaging
disableCallback(boolean) - Method in class com.lexalytics.salience.SalienceCollections
Enables or disables callback messaging
disableCallback(boolean, String) - Method in interface com.lexalytics.salience.ISalience
 
disableCallback(boolean, String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
disableCallback(boolean, String) - Method in class com.lexalytics.salience.Salience
Enables or disables callback messaging
disableCallback(boolean, String) - Method in class com.lexalytics.salience.SalienceCollections
Enables or disables callback messaging
dispose() - Method in interface com.lexalytics.salience.ISalience
 
dispose() - Method in interface com.lexalytics.salience.ISalienceCollections
 
dispose() - Method in class com.lexalytics.salience.Salience
Frees all resources associated with this Salience session.
dispose() - Method in class com.lexalytics.salience.SalienceCollections
Frees all resources associated with this Salience session.
DocumentDetails - Class in com.lexalytics.salience
The DocumentDetails object provides the statistical information about the document content determined by Salience.
DocumentDetails - Variable in class com.lexalytics.salience.Options
 
DocumentDetails(Vector<Section>) - Constructor for class com.lexalytics.salience.DocumentDetails
Creates a new DocumentDetails object.
DocumentDetailsOptions() - Constructor for class com.lexalytics.salience.Options.DocumentDetailsOptions
 
DocumentSentiment - Class in com.lexalytics.salience
The DocumentSentiment object provides all document-level sentiment results from Salience.
DocumentSentiment(float, Vector<SentimentModelScores>, Vector<SentimentPhrase>, Vector<Topic>) - Constructor for class com.lexalytics.salience.DocumentSentiment
Creates a new DocumentSentiment object.
dumpEnvironment() - Method in interface com.lexalytics.salience.ISalience
 
dumpEnvironment() - Method in class com.lexalytics.salience.Salience
Returns a representation of the internal state of Salience, specifically the values for Salience Options.

E

Entities - Variable in class com.lexalytics.salience.Options
 
Entity - Class in com.lexalytics.salience
An entity is an object that exists within the content.
Entity(Vector<Mention>, String, String, String, float, int, boolean, boolean, String, Vector<Theme>, Vector<EntityAttribute>, Vector<Topic>, Vector<SentimentPhrase>, Map<String, Set<Entity>>) - Constructor for class com.lexalytics.salience.Entity
Creates a new entity.
EntityAttribute - Class in com.lexalytics.salience
A Entity Attribute represents an additional hand coded piece of information about the entity.
EntityAttribute(String, String) - Constructor for class com.lexalytics.salience.EntityAttribute
Creates a new EntityAttribute.
EntityOptions() - Constructor for class com.lexalytics.salience.Options.EntityOptions
 
explainConceptMatches() - Method in interface com.lexalytics.salience.ISalience
 
explainConceptMatches() - Method in class com.lexalytics.salience.Salience
Returns a string listing the principal words in a document that contributed to each Concept Topic Match.
explainConceptMatches(String) - Method in interface com.lexalytics.salience.ISalience
 
explainConceptMatches(String) - Method in class com.lexalytics.salience.Salience
Returns a string listing the principal words in a document that contributed to each Concept Topic Match.

F

Facet - Class in com.lexalytics.salience
A Facet object represents a connection between a noun and other nouns or adjectives in a collection.
Facet(String, int, int, int, int, Vector<Attribute>, Vector<Phrase>, Vector<Phrase>, Vector<Phrase>, Vector<Phrase>) - Constructor for class com.lexalytics.salience.Facet
Creates a new facet.
fConfidence - Variable in class com.lexalytics.salience.OCRCharacterAttribute
 
fHeight - Variable in class com.lexalytics.salience.OCRCharacterAttribute
 
fWidth - Variable in class com.lexalytics.salience.OCRCharacterAttribute
 
fXPosition - Variable in class com.lexalytics.salience.OCRCharacterAttribute
 
fYPosition - Variable in class com.lexalytics.salience.OCRCharacterAttribute
 

G

getAbout() - Method in class com.lexalytics.salience.Theme
Boolean indicator of theme "aboutness".
getActualLabel() - Method in class com.lexalytics.salience.ModelSmokeTestReport
Returns classification label of document or span found by model in tested document.
getActualSpanLength() - Method in class com.lexalytics.salience.ModelSmokeTestReport
Returns length of mention (in characters) found by model in the document being tested.
getActualSpanOffset() - Method in class com.lexalytics.salience.ModelSmokeTestReport
Returns character offset of mention found by model within the document being tested.
getAlternateSentences() - Method in class com.lexalytics.salience.Summary
Retrieves the sentences of the alternate summary of the document.
getAlternateText() - Method in class com.lexalytics.salience.Summary
Retrieves the alternate summary of the document.
getAlternateTheme() - Method in class com.lexalytics.salience.AlternateTheme
The alternate theme text
getAlternateThemes() - Method in class com.lexalytics.salience.Theme
A list of alternate themes.
getAndCount() - Method in class com.lexalytics.salience.QueryInfo
 
getAttributeName() - Method in class com.lexalytics.salience.EntityAttribute
The entity attribute label
getAttributes() - Method in class com.lexalytics.salience.Facet
Retrieves the attributes for the facet.
getAttributeValue() - Method in class com.lexalytics.salience.EntityAttribute
The entity attribute value
getBigramFrequency() - Method in class com.lexalytics.salience.Section
Retrieves a term frequency analysis for the bigrams in the document.
GetByteLength() - Method in class com.lexalytics.salience.ChunkToken
Returns the byte length for the chunk (in UTF-8).
GetByteLength() - Method in class com.lexalytics.salience.Phrase
Returns the byte length for the phrase (in UTF-8).
GetByteLength() - Method in class com.lexalytics.salience.Word
Returns the byte length for the phrase (in UTF-8).
GetCharLength() - Method in class com.lexalytics.salience.ChunkToken
Returns the character length for the chunk (actual characters.
GetCharLength() - Method in class com.lexalytics.salience.Phrase
Returns the character length for the phrase (actual characters.
GetCharLength() - Method in class com.lexalytics.salience.Word
Returns the character length for the phrase (actual characters.
getChildMentions() - Method in class com.lexalytics.salience.Theme
A list of supporting theme mentions within the content.
getChildren() - Method in class com.lexalytics.salience.Topic
A vector containing child topics, if the results were generated from a topic hierarchy, like with GetDocumentCategories.
getChunks() - Method in class com.lexalytics.salience.Section
Retrieves the individual sentences in the document.
getChunks() - Method in class com.lexalytics.salience.Sentence
Retrieves a list of the Chunk items within the sentence.
getCollectionConceptDefinedTopics() - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionConceptDefinedTopics() - Method in class com.lexalytics.salience.SalienceCollections
Returns a list of topic labels identified for the collection via concepts.
getCollectionConceptDefinedTopics(String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionConceptDefinedTopics(String) - Method in class com.lexalytics.salience.SalienceCollections
Returns a list of topic labels identified for the collection via concepts.
getCollectionDetails() - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionDetails() - Method in class com.lexalytics.salience.SalienceCollections
Retrieves details about the collection.
getCollectionDetails(String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionDetails(String) - Method in class com.lexalytics.salience.SalienceCollections
Retrieves details about the collection.
getCollectionEntities() - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionEntities() - Method in class com.lexalytics.salience.SalienceCollections
Retrieves a list of named entities from the documents in the collection.
getCollectionEntities(String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionEntities(String) - Method in class com.lexalytics.salience.SalienceCollections
Retrieves a list of named entities from the documents in the collection.
getCollectionFacets() - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionFacets() - Method in class com.lexalytics.salience.SalienceCollections
Retrieves facets aggregated across all documents in the collection.
getCollectionFacets(String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionFacets(String) - Method in class com.lexalytics.salience.SalienceCollections
Retrieves facets aggregated across all documents in the collection.
getCollectionQueryDefinedTopics() - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionQueryDefinedTopics() - Method in class com.lexalytics.salience.SalienceCollections
Returns a list of topic labels identified for the documents in the collection via queries.
getCollectionQueryDefinedTopics(String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionQueryDefinedTopics(String) - Method in class com.lexalytics.salience.SalienceCollections
Returns a list of topic labels identified for the documents in the collection via queries.
getCollectionThemes() - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionThemes() - Method in class com.lexalytics.salience.SalienceCollections
Retrieves themes aggregated across all documents in the collection.
getCollectionThemes(String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionThemes(String) - Method in class com.lexalytics.salience.SalienceCollections
Retrieves themes aggregated across all documents in the collection.
getCollectionUserEntities() - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionUserEntities() - Method in class com.lexalytics.salience.SalienceCollections
Retrieves a list of user entities from the documents in the collection.
getCollectionUserEntities(String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
getCollectionUserEntities(String) - Method in class com.lexalytics.salience.SalienceCollections
Retrieves a list of user entities from the documents in the collection.
getColumn(int) - Method in class com.lexalytics.salience.Row
Retrieves an entry at the specified index.
GetColumn() - Method in class com.lexalytics.salience.Phrase
Returns the zero-based index of the column if this phrase occurs in a table.
getColumnCount() - Method in class com.lexalytics.salience.Row
Retrieves the number of columns in this row.
getColumns() - Method in class com.lexalytics.salience.Row
Retrieves the column entries for this row.
getConceptTopics() - Method in interface com.lexalytics.salience.ISalience
 
getConceptTopics() - Method in class com.lexalytics.salience.Salience
Returns a list of topics identified for the document via concepts.
getConceptTopics(String) - Method in interface com.lexalytics.salience.ISalience
 
getConceptTopics(String) - Method in class com.lexalytics.salience.Salience
Returns a list of topics identified for the document via concepts.
getConfidenceScore() - Method in class com.lexalytics.salience.Relationship
Retrieves a measure of confidence in the relationship extraction.
getCount() - Method in class com.lexalytics.salience.Attribute
Retrieves a count of the occurrences of the attribute.
getCount() - Method in class com.lexalytics.salience.CollectionEntity
Retrieves the number of occurrences of the entity across all collection documents.
getCount() - Method in class com.lexalytics.salience.Facet
Retrieve a count of the number of occurrences of the facet throughout the collection.
getDocumentCategories() - Method in interface com.lexalytics.salience.ISalience
 
getDocumentCategories() - Method in class com.lexalytics.salience.Salience
Returns a list of topics identified for the document via the category model.
getDocumentCategories(String) - Method in interface com.lexalytics.salience.ISalience
 
getDocumentCategories(String) - Method in class com.lexalytics.salience.Salience
Returns a list of topics identified for the document via the category model.
getDocumentClasses() - Method in interface com.lexalytics.salience.ISalience
 
getDocumentClasses() - Method in class com.lexalytics.salience.Salience
Gets the classes for the specified document
getDocumentClasses(String) - Method in interface com.lexalytics.salience.ISalience
 
getDocumentClasses(String) - Method in class com.lexalytics.salience.Salience
Gets the classes for the specified document
getDocumentDetails() - Method in interface com.lexalytics.salience.ISalience
 
getDocumentDetails() - Method in class com.lexalytics.salience.Salience
Retrieves statistical information about the document.
getDocumentDetails(String) - Method in interface com.lexalytics.salience.ISalience
 
getDocumentDetails(String) - Method in class com.lexalytics.salience.Salience
Retrieves statistical information about the document.
getDocumentId() - Method in class com.lexalytics.salience.ModelSmokeTestReport
Returns ID of document on which test was run.
getDocumentIntentions() - Method in interface com.lexalytics.salience.ISalience
 
getDocumentIntentions() - Method in class com.lexalytics.salience.Salience
Calculates a list of intentions in the document.
getDocumentIntentions(String) - Method in interface com.lexalytics.salience.ISalience
 
getDocumentIntentions(String) - Method in class com.lexalytics.salience.Salience
Calculates a list of intentions in the document.
GetDocumentNumber() - Method in class com.lexalytics.salience.Phrase
Returns the document index within a collection (if applicable) in which the phrase occurs.
getDocumentSentiment(boolean) - Method in interface com.lexalytics.salience.ISalience
 
getDocumentSentiment(boolean) - Method in class com.lexalytics.salience.Salience
Calculates an overall sentiment score for the current document.
getDocumentSentiment(boolean, String) - Method in interface com.lexalytics.salience.ISalience
 
getDocumentSentiment(boolean, String) - Method in class com.lexalytics.salience.Salience
Calculates an overall sentiment score for the current document.
getDocumentThemes() - Method in interface com.lexalytics.salience.ISalience
 
getDocumentThemes() - Method in class com.lexalytics.salience.Salience
Calculates a list of themes in the document.
getDocumentThemes(String) - Method in interface com.lexalytics.salience.ISalience
 
getDocumentThemes(String) - Method in class com.lexalytics.salience.Salience
Calculates a list of themes in the document.
getDocumentTopics() - Method in interface com.lexalytics.salience.ISalience
 
getDocumentTopics() - Method in class com.lexalytics.salience.Salience
Returns a list of topics identified for the document via query.
getDocumentTopics(String) - Method in interface com.lexalytics.salience.ISalience
 
getDocumentTopics(String) - Method in class com.lexalytics.salience.Salience
Returns a list of topics identified for the document via query.
getEmotionResults() - Method in class com.lexalytics.salience.DocumentSentiment
Added in Salience 5.1: Retrieves the emotions detected in the document, which provide a different perspective to the sentiment score for the document.
getEntities() - Method in class com.lexalytics.salience.Relationship
Retrieves a list of the Entity objects that comprise the relationship.
getEntities() - Method in class com.lexalytics.salience.Topic
A vector containing entities for the topic.
getEntityAttributes() - Method in class com.lexalytics.salience.Entity
A list of entityattributes related to this entity.
getEntityTaggedText() - Method in interface com.lexalytics.salience.ISalience
 
getEntityTaggedText() - Method in class com.lexalytics.salience.Salience
Gets the document text with any entity references tagged.
getEntityTaggedText(String) - Method in interface com.lexalytics.salience.ISalience
 
getEntityTaggedText(String) - Method in class com.lexalytics.salience.Salience
Gets the document text with any entity references tagged.
getErrorMessage() - Method in class com.lexalytics.salience.QueryInfo
 
getEvidence() - Method in class com.lexalytics.salience.Entity
Evidence is a measure of the content available to determine the sentiment score for the entity.
getEvidence() - Method in class com.lexalytics.salience.Intention
Retrieves the evidence phrase of the intention.
getEvidence() - Method in class com.lexalytics.salience.Theme
Evidence is a measure of the content available to determine the sentiment score for the theme.
getEvidenceChunk() - Method in class com.lexalytics.salience.Intention
Retrieves the Chunk object relating to the evidence phrase of the intention
getExcludeCount() - Method in class com.lexalytics.salience.QueryInfo
 
getExpectedLabel() - Method in class com.lexalytics.salience.ModelSmokeTestReport
Returns expected classification label of tested document or span in tested document.
getExpectedSpanLength() - Method in class com.lexalytics.salience.ModelSmokeTestReport
Returns expected length of mention (in characters) in the document being tested.
getExpectedSpanOffset() - Method in class com.lexalytics.salience.ModelSmokeTestReport
Returns expected character offset of a mention within the document being tested.
getExplanation() - Method in class com.lexalytics.salience.ModelSmokeTestReport
Returns contextual information about the test outcome.
getExtra() - Method in class com.lexalytics.salience.Relationship
Retrieves any extra information that has been extracted about the relationship.
getFingerprint() - Method in class com.lexalytics.salience.Section
 
getHeader() - Method in class com.lexalytics.salience.Section
Retrieves the header for this section.
getHitCount() - Method in class com.lexalytics.salience.Topic
The number of hits for the topic.
getIntensifierFrequency() - Method in class com.lexalytics.salience.Section
Retrieves a term frequency analysis for the intensifiers in the document.
getIsTheme() - Method in class com.lexalytics.salience.Opinion
Retrieves whether the opinion is about a theme (as opposed to an entity).
getLabel() - Method in class com.lexalytics.salience.Attribute
Retrieves the text of the attribute.
getLabel() - Method in class com.lexalytics.salience.BasicLabel
The label for the supplied text.
getLabel() - Method in class com.lexalytics.salience.Chunk
A label describing the grammatical type of the chunk.
getLabel() - Method in class com.lexalytics.salience.CollectionEntity
A descriptive label for the entity.
getLabel() - Method in class com.lexalytics.salience.Entity
A descriptive label for the entity.
getLabel() - Method in class com.lexalytics.salience.Facet
Retrieves the text of the facet.
getLabel() - Method in class com.lexalytics.salience.QueryInfo
 
getLastWarnings() - Method in interface com.lexalytics.salience.ISalience
 
getLastWarnings() - Method in interface com.lexalytics.salience.ISalienceCollections
 
getLastWarnings() - Method in class com.lexalytics.salience.Salience
Gets any warnings issued by the last call to Salience.prepareText(java.lang.String) or Salience.prepareTextFromFile(java.lang.String) made using this session.
getLastWarnings() - Method in class com.lexalytics.salience.SalienceCollections
getMentions() - Method in class com.lexalytics.salience.Attribute
Retrieves a list of the mentions of the attributes.
getMentions() - Method in class com.lexalytics.salience.CollectionEntity
A list of entity mentions within the collection.
getMentions() - Method in class com.lexalytics.salience.Entity
A list of entity mentions within the content.
getMentions() - Method in class com.lexalytics.salience.Facet
Retrieves the individual mentions for the facet.
getMentions() - Method in class com.lexalytics.salience.Theme
A list of theme mentions within the content.
getMentions() - Method in class com.lexalytics.salience.Topic
A vector containing hits for the topic.
getMessage() - Method in class com.lexalytics.salience.ModelSmokeTestReport
Returns a well-known message for the type of test outcome.
getMixedScore() - Method in class com.lexalytics.salience.SentimentModelScores
Retrieve a likelihood score that the document content is mixed sentiment.
getModelName() - Method in class com.lexalytics.salience.SentimentModelScores
Retrieve the name of the model used to analyze the document for sentiment.
getModelPath() - Method in class com.lexalytics.salience.ModelSmokeTestReport
Returns the absolute file path to the model being test.
getModified() - Method in class com.lexalytics.salience.SentimentPhrase
A bitmask indicating the modifications used, such as intensifiers or negators.
GetModifierType() - Method in class com.lexalytics.salience.Phrase
Returns the type if the phrase is a negator or an intensifier.
getMostLikelySentiment() - Method in class com.lexalytics.salience.SentimentModelScores
Retrieve an integer value that provides an easy indication of the sentiment classification that achieved the highest score.
getNamedEntities() - Method in interface com.lexalytics.salience.ISalience
 
getNamedEntities() - Method in class com.lexalytics.salience.Salience
Retrieves a list of named entities in the current document.
getNamedEntities(String) - Method in interface com.lexalytics.salience.ISalience
 
getNamedEntities(String) - Method in class com.lexalytics.salience.Salience
Retrieves a list of named entities in the current document.
getNamedEntityOpinions() - Method in interface com.lexalytics.salience.ISalience
 
getNamedEntityOpinions() - Method in class com.lexalytics.salience.Salience
Returns a list of opinions expressed in a document about named entities.
getNamedEntityOpinions(String) - Method in interface com.lexalytics.salience.ISalience
 
getNamedEntityOpinions(String) - Method in class com.lexalytics.salience.Salience
Returns a list of opinions expressed in a document about named entities.
getNamedEntityRelationships() - Method in interface com.lexalytics.salience.ISalience
 
getNamedEntityRelationships() - Method in class com.lexalytics.salience.Salience
Extracts a list of relationships between named entities in the document.
getNamedEntityRelationships(String) - Method in interface com.lexalytics.salience.ISalience
 
getNamedEntityRelationships(String) - Method in class com.lexalytics.salience.Salience
Extracts a list of relationships between named entities in the document.
getNamedOpinionTaggedText() - Method in interface com.lexalytics.salience.ISalience
 
getNamedOpinionTaggedText() - Method in class com.lexalytics.salience.Salience
Tags opinions expressed in a document about/expressed by named entities
getNamedOpinionTaggedText(String) - Method in interface com.lexalytics.salience.ISalience
 
getNamedOpinionTaggedText(String) - Method in class com.lexalytics.salience.Salience
Tags opinions expressed in a document about/expressed by named entities
getNearCount() - Method in class com.lexalytics.salience.QueryInfo
 
getNearDepth() - Method in class com.lexalytics.salience.QueryInfo
 
getNegativeCount() - Method in class com.lexalytics.salience.Attribute
Retrieves a negative count of the occurrences of the attribute.
getNegativeCount() - Method in class com.lexalytics.salience.CollectionEntity
Retrieves the number of negative occurrences of the entity across all collection documents.
getNegativeCount() - Method in class com.lexalytics.salience.Facet
Retrieves the number of negative occurrences of the facet across all collection documents.
getNegativeMentions() - Method in class com.lexalytics.salience.Attribute
Retrieves a list of the negative mentions of the attributes.
getNegativeMentions() - Method in class com.lexalytics.salience.Facet
Retrieves the individual negative mentions for the facet.
getNegativeScore() - Method in class com.lexalytics.salience.SentimentModelScores
Retrieve a likelihood score that the document sentiment is negative.
GetNegator() - Method in class com.lexalytics.salience.Phrase
Returns a negating phrase, if applicable.
getNegatorFrequency() - Method in class com.lexalytics.salience.Section
Retrieves a term frequency analysis for the negators in the document.
getNeutralCount() - Method in class com.lexalytics.salience.Attribute
Retrieves a neutral count of the occurrences of the attribute.
getNeutralCount() - Method in class com.lexalytics.salience.CollectionEntity
Retrieves the number of neutral occurrences of the entity across all collection documents.
getNeutralCount() - Method in class com.lexalytics.salience.Facet
Retrieves the number of neutral occurrences of the facet across all collection documents.
getNeutralMentions() - Method in class com.lexalytics.salience.Attribute
Retrieves a list of the neutral mentions of the attributes.
getNeutralMentions() - Method in class com.lexalytics.salience.Facet
Retrieves the individual neutral mentions of the facet.
getNeutralScore() - Method in class com.lexalytics.salience.SentimentModelScores
Retrieve a likelihood score that the document content is neutral.
getNormalizedForm() - Method in class com.lexalytics.salience.CollectionEntity
The normalized for of the entity.
getNormalizedForm() - Method in class com.lexalytics.salience.Entity
The normalized for of the entity.
getNormalizedTheme() - Method in class com.lexalytics.salience.Theme
The normalized version of the theme text
getNotCount() - Method in class com.lexalytics.salience.QueryInfo
 
getObjectiveCount() - Method in class com.lexalytics.salience.Section
Retrieves the number of sentences in the document that are marked as objective.
getOptions() - Method in interface com.lexalytics.salience.ISalience
 
getOptions() - Method in interface com.lexalytics.salience.ISalienceCollections
 
getOptions() - Method in class com.lexalytics.salience.Salience
 
getOptions() - Method in class com.lexalytics.salience.SalienceCollections
 
getOrCount() - Method in class com.lexalytics.salience.QueryInfo
 
getParsedCount() - Method in class com.lexalytics.salience.Section
Retrieves the number of sentences in the document that were grammatically parsed.
getPositiveCount() - Method in class com.lexalytics.salience.Attribute
Retrieves a positive count of the occurrences of the attribute.
getPositiveCount() - Method in class com.lexalytics.salience.CollectionEntity
Retrieves the number of positive occurrences of the entity across all collection documents.
getPositiveCount() - Method in class com.lexalytics.salience.Facet
Retrieves the number of positive occurrences of the facet across all collection documents.
getPositiveMentions() - Method in class com.lexalytics.salience.Attribute
Retrieves a list of the positive mentions of the attributes.
getPositiveMentions() - Method in class com.lexalytics.salience.Facet
Retrieves the individual positive mentions for the facet.
getPositiveScore() - Method in class com.lexalytics.salience.SentimentModelScores
Retrieve a likelihood score that the document sentiment is positive.
getPOSTag() - Method in class com.lexalytics.salience.ChunkToken
Retrieves the part-of-speech tag for the chunk token.
getPOSTag() - Method in class com.lexalytics.salience.Word
The part-of-speech tag for the token.
getPOSTaggedText() - Method in interface com.lexalytics.salience.ISalience
 
getPOSTaggedText() - Method in class com.lexalytics.salience.Salience
Tags the text of the document with part of speech information.
getPOSTaggedText(String) - Method in interface com.lexalytics.salience.ISalience
 
getPOSTaggedText(String) - Method in class com.lexalytics.salience.Salience
Tags the text of the document with part of speech information.
getQuadgramFrequency() - Method in class com.lexalytics.salience.Section
Retrieves a term frequency analysis for the quadgrams in the document in ideogram languages.
getQuotation() - Method in class com.lexalytics.salience.Opinion
Retrieves a quotation related to the opinion, if one exists.
getReference() - Method in class com.lexalytics.salience.Relationship
Retrieves the paths and line numbers of rules/models that generated this relationship.
getRelatedEntities() - Method in class com.lexalytics.salience.Entity
 
getRelatedEntities() - Method in class com.lexalytics.salience.Relationship
The entities that make up this relationship, indexed by their role in the relationship.
getRelatedMentions() - Method in class com.lexalytics.salience.Theme
A list of related theme mentions within the content.
GetRow() - Method in class com.lexalytics.salience.Phrase
Returns the zero-based index of the row if this phrase occurs in a list or a table.
getRows() - Method in class com.lexalytics.salience.Section
Retrieves the rows in the document if it corresponds to a table or list.
getRuleID() - Method in class com.lexalytics.salience.BasicSentimentRule
The rule ID.
getScore() - Method in class com.lexalytics.salience.AlternateTheme
Score giving indication of the strength of the alternate themes, higher scores are stronger alternate themes.
getScore() - Method in class com.lexalytics.salience.Theme
Score giving indication of the strength of the theme, higher scores are stronger themes.
getScore() - Method in class com.lexalytics.salience.Topic
A score value for the topic.
GetScore() - Method in class com.lexalytics.salience.Mention
Retrieves the score for the mention, a value between 0 and 100.
GetSection() - Method in class com.lexalytics.salience.Phrase
Returns the zero-based index of the document details this phrase occurs in.
getSections() - Method in class com.lexalytics.salience.DocumentDetails
Retrieves a Vector of Section objects.
getSentenceCount() - Method in class com.lexalytics.salience.Section
Retrieves the number of sentences in the document.
getSentenceNumber() - Method in class com.lexalytics.salience.Chunk
A zero-based index of the sentence in the document that is the source of the chunk.
GetSentenceNumber() - Method in class com.lexalytics.salience.Phrase
Returns the sentence index within a document in which the phrase occurs.
getSentences() - Method in class com.lexalytics.salience.Summary
Retrieves the sentences of the summary of the document.
getSentiment() - Method in class com.lexalytics.salience.BasicSentimentRule
The new sentiment.
getSentiment() - Method in class com.lexalytics.salience.Chunk
The sentiment score of the chunk.
getSentiment() - Method in class com.lexalytics.salience.Opinion
Retrieves the sentiment of the opinion.
getSentiment() - Method in class com.lexalytics.salience.Sentence
Retrieves the sentiment score of the sentence.
getSentiment() - Method in class com.lexalytics.salience.Theme
Sentiment score associated with content related to the theme.
getSentiment() - Method in class com.lexalytics.salience.Topic
Added in Salience 5.1: The sentiment score associated with the topic.
getSentiment() - Method in class com.lexalytics.salience.Word
The sentiment score for the token.
getSentimentModelResults() - Method in class com.lexalytics.salience.DocumentSentiment
Retrieves the model-based sentiment analysis for the document.
getSentimentPhrases() - Method in class com.lexalytics.salience.DocumentSentiment
Retrieves the phrase-based sentiment analysis for the document.
getSentimentPhrases() - Method in class com.lexalytics.salience.Entity
A list of sentiment bearing phrases related to the entity.
getSentimentPhrases() - Method in class com.lexalytics.salience.Topic
A list of sentiment bearing phrases related to the topic.
getSentimentScore() - Method in class com.lexalytics.salience.DocumentSentiment
Retrieves the phrase-based sentiment score for the document.
getSentimentScore() - Method in class com.lexalytics.salience.Entity
Sentiment score associated with content related to the entity.
getSentimentScore() - Method in class com.lexalytics.salience.SentimentPhrase
Returns the sentiment score for the phrase
getSentimentTaggedText() - Method in interface com.lexalytics.salience.ISalience
 
getSentimentTaggedText() - Method in class com.lexalytics.salience.Salience
Tags any phrases in the document that would contribute to sentiment calculation by whether they are positive, negative or neutral.
getSentimentTaggedText(String) - Method in interface com.lexalytics.salience.ISalience
 
getSentimentTaggedText(String) - Method in class com.lexalytics.salience.Salience
Tags any phrases in the document that would contribute to sentiment calculation by whether they are positive, negative or neutral.
getSize() - Method in class com.lexalytics.salience.CollectionDetails
The number of documents within the collection.
getSource() - Method in class com.lexalytics.salience.SentimentPhrase
Returns the source of the sentiment phrase.
getSpeaker() - Method in class com.lexalytics.salience.Opinion
Retrieves the speaker of the opinion.
GetStartByte() - Method in class com.lexalytics.salience.ChunkToken
Returns the byte offset within the document for the chunk (in UTF-8).
GetStartByte() - Method in class com.lexalytics.salience.Phrase
Returns the byte offset within the document for the phrase (in UTF-8).
GetStartByte() - Method in class com.lexalytics.salience.Word
Returns the byte offset within the document for the phrase (in UTF-8).
GetStartChar() - Method in class com.lexalytics.salience.ChunkToken
Returns the character offset within the document for the chunk (actual characters.
GetStartChar() - Method in class com.lexalytics.salience.Phrase
Returns the character offset within the document for the phrase (actual characters.
GetStartChar() - Method in class com.lexalytics.salience.Word
Returns the character offset within the document for the phrase (actual characters.
GetStartToken() - Method in class com.lexalytics.salience.Phrase
Returns the word index in which the phrase occurs.
getStem() - Method in class com.lexalytics.salience.ChunkToken
The stemmed form of the chunk.
getStem() - Method in class com.lexalytics.salience.Word
The stemmed form of the token.
getStemmedTheme() - Method in class com.lexalytics.salience.Theme
The stemmed version of the theme text
getSubjectiveCount() - Method in class com.lexalytics.salience.Section
Retrieves the number of sentences in the document that are marked as subjective.
getSubQueryCount() - Method in class com.lexalytics.salience.QueryInfo
 
getSubQueryDepth() - Method in class com.lexalytics.salience.QueryInfo
 
getSummary() - Method in class com.lexalytics.salience.Entity
A summary of content related to the entity.
getSummary() - Method in class com.lexalytics.salience.Theme
A summary of content related to the theme.
getSummary() - Method in class com.lexalytics.salience.Topic
A summary of content related to the topic.
getSummary(int) - Method in interface com.lexalytics.salience.ISalience
 
getSummary(int) - Method in class com.lexalytics.salience.Salience
Generates a summary of the current document (the last text passed to Salience.prepareText(java.lang.String) or Salience.prepareTextFromFile(java.lang.String)).
getSummary(int, String) - Method in interface com.lexalytics.salience.ISalience
 
getSummary(int, String) - Method in class com.lexalytics.salience.Salience
Generates a summary of the current document (the last text passed to Salience.prepareText(java.lang.String) or Salience.prepareTextFromFile(java.lang.String)).
getSummaryRank() - Method in class com.lexalytics.salience.Sentence
Retrieves the ranking of the sentence with regards to summary.
getSupportingPhrases() - Method in class com.lexalytics.salience.SentimentPhrase
Any phrase that supports the sentiment phrase.
getTaggedBigramFrequency() - Method in class com.lexalytics.salience.Section
Retrieves a tagged term frequency analysis for the bigrams in the document.
getTaggedTokenFrequency() - Method in class com.lexalytics.salience.Section
Retrieves a tagged term frequency analysis for the tokens in the document.
getTaggedTrigramFrequency() - Method in class com.lexalytics.salience.Section
Retrieves a tagged term frequency analysis for the trigrams in the document.
getTermCount() - Method in class com.lexalytics.salience.QueryInfo
 
getText() - Method in class com.lexalytics.salience.BasicSentimentRule
The user supplied text in need of a sentiment change.
getText() - Method in class com.lexalytics.salience.Section
Retrieves the system's internal representation of the document.
getText() - Method in class com.lexalytics.salience.Sentence
Retrieves the text of the sentence.
getText() - Method in class com.lexalytics.salience.Summary
Retrieves the summary of the document.
GetText() - Method in class com.lexalytics.salience.Phrase
Returns the text of the phrase.
getTheme() - Method in class com.lexalytics.salience.Theme
The theme text
getThemes() - Method in class com.lexalytics.salience.Entity
A list of themes related to this entity.
getToken() - Method in class com.lexalytics.salience.ChunkToken
Retrieves the chunk token.
getToken() - Method in class com.lexalytics.salience.Word
The text of the token.
getTokenFrequency() - Method in class com.lexalytics.salience.Section
Retrieves a term frequency analysis for the tokens in the document.
GetTokenLength() - Method in class com.lexalytics.salience.Phrase
Returns the length (in tokens) for the phrase.
getTokens() - Method in class com.lexalytics.salience.Chunk
Retrieves a list of the tokens in the chunk.
getTopic() - Method in class com.lexalytics.salience.Opinion
Retrieves the subject of the opinion.
getTopic() - Method in class com.lexalytics.salience.Topic
Returns the label for the topic.
getTopics() - Method in class com.lexalytics.salience.Entity
Added in Salience 5.1: A list of topics related to the entity.
getTopics() - Method in class com.lexalytics.salience.Theme
Added in Salience 5.1: A list of topics related to the theme.
getTrigramFrequency() - Method in class com.lexalytics.salience.Section
Retrieves a term frequency analysis for the trigrams in the document.
getType() - Method in class com.lexalytics.salience.CollectionEntity
The entity type is a general classification of the entity, as determined by the entity extraction model or data file customizations to specify the entity type.
getType() - Method in class com.lexalytics.salience.Entity
The entity type is a general classification of the entity, as determined by the entity extraction model or data file customizations to specify the entity type.
getType() - Method in class com.lexalytics.salience.Intention
Retrieves the type of intention.
getType() - Method in class com.lexalytics.salience.Relationship
Retrieves a label describing the nature of the relationship.
getType() - Method in class com.lexalytics.salience.SentimentPhrase
Returns the type of phrase this is.
getType() - Method in class com.lexalytics.salience.Topic
Added in Salience 5.2: An int value indicating whether the topic is a concept topic or a query topic.
GetType() - Method in class com.lexalytics.salience.Mention
Retrieves the type for the mention.
getUserEntities() - Method in interface com.lexalytics.salience.ISalience
 
getUserEntities() - Method in class com.lexalytics.salience.Salience
Retrieves a list of entities from a supplied list that appear in the current document.
getUserEntities(String) - Method in interface com.lexalytics.salience.ISalience
 
getUserEntities(String) - Method in class com.lexalytics.salience.Salience
Retrieves a list of entities from a supplied list that appear in the current document.
getUserEntityOpinions() - Method in interface com.lexalytics.salience.ISalience
 
getUserEntityOpinions() - Method in class com.lexalytics.salience.Salience
Returns a list of opinions expressed in a document about user entities
getUserEntityOpinions(String) - Method in interface com.lexalytics.salience.ISalience
 
getUserEntityOpinions(String) - Method in class com.lexalytics.salience.Salience
Returns a list of opinions expressed in a document about user entities
getUserEntityRelationships() - Method in interface com.lexalytics.salience.ISalience
 
getUserEntityRelationships() - Method in class com.lexalytics.salience.Salience
Extracts a list of relationships between user entities in the document.
getUserEntityRelationships(String) - Method in interface com.lexalytics.salience.ISalience
 
getUserEntityRelationships(String) - Method in class com.lexalytics.salience.Salience
Extracts a list of relationships between user entities in the document.
getUserEntityTaggedText() - Method in interface com.lexalytics.salience.ISalience
 
getUserEntityTaggedText() - Method in class com.lexalytics.salience.Salience
Tags references to user entities from a file found in the text of the document.
getUserEntityTaggedText(String) - Method in interface com.lexalytics.salience.ISalience
 
getUserEntityTaggedText(String) - Method in class com.lexalytics.salience.Salience
Tags references to user entities from a file found in the text of the document.
getUserOpinionTaggedText() - Method in interface com.lexalytics.salience.ISalience
 
getUserOpinionTaggedText() - Method in class com.lexalytics.salience.Salience
Tags opinions expressed in a document about/expressed by user entities
getUserOpinionTaggedText(String) - Method in interface com.lexalytics.salience.ISalience
 
getUserOpinionTaggedText(String) - Method in class com.lexalytics.salience.Salience
Tags opinions expressed in a document about/expressed by user entities
getValidateConceptQueryFile(String) - Method in interface com.lexalytics.salience.ISalience
 
getValidateConceptQueryFile(String) - Method in class com.lexalytics.salience.Salience
Validates concept queries from a provided query file, returning information about each query including error messages if the query was malformed.
getValidateConceptQueryString(String) - Method in interface com.lexalytics.salience.ISalience
 
getValidateConceptQueryString(String) - Method in class com.lexalytics.salience.Salience
Validates concept queries presented as a string, returning information about each query including error messages if the query was malformed.
getValidateQueryFile(String) - Method in interface com.lexalytics.salience.ISalience
 
getValidateQueryFile(String) - Method in class com.lexalytics.salience.Salience
Validates queries from a provided query file, returning information about each query including error messages if the query was malformed.
getValidateQueryFile(String, String) - Method in interface com.lexalytics.salience.ISalience
 
getValidateQueryFile(String, String) - Method in class com.lexalytics.salience.Salience
Validates queries from a provided query file, returning information about each query including error messages if the query was malformed.
getValidateQueryString(String) - Method in interface com.lexalytics.salience.ISalience
 
getValidateQueryString(String) - Method in class com.lexalytics.salience.Salience
Validates queries presented as a string, returning information about each query including error messages if the query was malformed.
getValidateQueryString(String, String) - Method in interface com.lexalytics.salience.ISalience
 
getValidateQueryString(String, String) - Method in class com.lexalytics.salience.Salience
Validates queries presented as a string, returning information about each query including error messages if the query was malformed.
getVersion() - Static method in class com.lexalytics.salience.Salience
Gets the version of Salience.
getWhat() - Method in class com.lexalytics.salience.Intention
Retrieves what the object of the intention is.
getWhatChunk() - Method in class com.lexalytics.salience.Intention
Retrieves the Chunk object relating to what the object of the intention is.
getWho() - Method in class com.lexalytics.salience.Intention
Retrieves who expressed the intention
getWhoChunk() - Method in class com.lexalytics.salience.Intention
Retrieves the Chunk object relating to who expressed the intention
getWildCardCount() - Method in class com.lexalytics.salience.QueryInfo
 
getWordCount() - Method in class com.lexalytics.salience.Section
Retrieves the number of words in the document.
getWords() - Method in class com.lexalytics.salience.Sentence
Retrieves a list of the Word items within the sentence.

I

Intention - Class in com.lexalytics.salience
An Intention object represents an intended action expressed in a document.
Intention(String, String, String, String, Chunk, Chunk, Chunk) - Constructor for class com.lexalytics.salience.Intention
Creates a new intention.
isAbout() - Method in class com.lexalytics.salience.Entity
Boolean indicator of theme "aboutness".
ISalience - Interface in com.lexalytics.salience
 
ISalience.Warning - Enum in com.lexalytics.salience
An enumeration providing the possible warnings that can be returned from the Salience.getLastWarnings() call.
ISalienceCollections - Interface in com.lexalytics.salience
 
ISalienceCollections.Warning - Enum in com.lexalytics.salience
An enumeration providing the possible warnings that can be returned from the SalienceCollections.getLastWarnings() call.
isConfident() - Method in class com.lexalytics.salience.Entity
An flag indicating if the entity has match confidence queries defined in the data files.
isImperative() - Method in class com.lexalytics.salience.Sentence
Added in Salience 5.1: Retrieves an indication of whether or not the sentence content contains an imperative, or call-to-action, statement.
isInverter() - Method in class com.lexalytics.salience.ChunkToken
Indicates whether the chunk token inverts sentiment.
isInverter() - Method in class com.lexalytics.salience.Word
A flag indicating if the token is or is part of a sentiment inverting construction such as a negator.
isMeta() - Method in class com.lexalytics.salience.Theme
A meta-theme is one that occurs as a part of other themes.
isNegated() - Method in class com.lexalytics.salience.Phrase
Returns a flag indicating whether or not the phrase has been negated.
isPolar() - Method in class com.lexalytics.salience.Sentence
Added in Salience 5.1: Retrieves an indication of whether or not the sentence content contains sentiment polarity.
isPostFixed() - Method in class com.lexalytics.salience.Word
A flag indicating that for display, the following term shouldn't be separated by a space
isSubjective() - Method in class com.lexalytics.salience.Sentence
Retrieves an indication of whether or not the sentence content is subjective or not.
isValid() - Method in class com.lexalytics.salience.QueryInfo
 

L

LARGE_DOCUMENT - com.lexalytics.salience.ISalience.Warning
The document exceeds 200kb in text, and thus may take longer in processing.
LARGE_DOCUMENT - com.lexalytics.salience.ISalienceCollections.Warning
The document exceeds 200kb in text, and thus may take longer in processing.
ListLabelFilters(String) - Method in interface com.lexalytics.salience.ISalience
 
ListLabelFilters(String) - Method in class com.lexalytics.salience.Salience
List the basic label filters.
ListSentimentRules(String) - Method in interface com.lexalytics.salience.ISalience
 
ListSentimentRules(String) - Method in class com.lexalytics.salience.Salience
List the basic sentiment rules for the given configuration.

M

Mention - Class in com.lexalytics.salience
A Mention object represents a specific occurrence of a specific item within the content.
Mention(String, int, int, int, int, int, int, int, int, int, int, int, Mention.MentionType, float) - Constructor for class com.lexalytics.salience.Mention
Creates a new mention.
Mention.MentionType - Enum in com.lexalytics.salience
An enumeration of possible mention types
mixed - com.lexalytics.salience.SentimentCategory
Used to indicate mixed sentiment.
ModelSmokeTestReport - Class in com.lexalytics.salience
A model smoke test report is a report about documents run against machine-learning models in a Salience configuration directory.
ModelSmokeTestReport(String, String, String, String, String, String, String, String, String, String) - Constructor for class com.lexalytics.salience.ModelSmokeTestReport
Creates a new model smoke test report.

N

NAMED - com.lexalytics.salience.Mention.MentionType
A proper reference of the item
nCharOffset - Variable in class com.lexalytics.salience.OCRCharacterAttribute
 
negative - com.lexalytics.salience.SentimentCategory
Used to indicate negative sentiment.
neutral - com.lexalytics.salience.SentimentCategory
Used to indicate neutral sentiment.
NO_PUNCTUATION - com.lexalytics.salience.ISalience.Warning
The document contains no punctuation, and thus will appear to Salience as one long sentence.
NO_PUNCTUATION - com.lexalytics.salience.ISalienceCollections.Warning
The document contains no punctuation, and thus will appear to Salience as one long sentence.
NO_WHITESPACE - com.lexalytics.salience.ISalience.Warning
The document contains no whitespace, and thus will appear to Salience as one long word.
NO_WHITESPACE - com.lexalytics.salience.ISalienceCollections.Warning
The document contains no whitespace, and thus will appear to Salience as one long word.
NOMINAL - com.lexalytics.salience.Mention.MentionType
A secondary reference to the item
NON_UTF8 - com.lexalytics.salience.ISalience.Warning
The document contains at least one non-UTF8 character.
NON_UTF8 - com.lexalytics.salience.ISalienceCollections.Warning
The document contains at least one non-UTF8 character.
nPage - Variable in class com.lexalytics.salience.OCRCharacterAttribute
 

O

OCRCharacterAttribute - Class in com.lexalytics.salience
An OCRCharacterAttribute object represents the location of an OCR'ed character on a document page and the confidence that the character was read correctly.
OCRCharacterAttribute(int, float, float, float, float, float, int) - Constructor for class com.lexalytics.salience.OCRCharacterAttribute
Creates a new OCR character attribute.
Opinion - Class in com.lexalytics.salience
An Opinion object represents a connection between a speaker and a topic for which an opinion is being expressed.
Opinion(String, String, String, float, boolean) - Constructor for class com.lexalytics.salience.Opinion
Creates a new opinion object.
options - Variable in class com.lexalytics.salience.Salience
Access to the Options for this Salience session.
Options - Class in com.lexalytics.salience
Base class for all Salience options
Options - Variable in class com.lexalytics.salience.SalienceCollections
Access to the Options for this Salience session.
Options(SalienceWrapper) - Constructor for class com.lexalytics.salience.Options
 
Options.BaseOptions - Class in com.lexalytics.salience
Base class for all general Salience options
Options.BasicLanguageOptions - Class in com.lexalytics.salience
Base class for Basic Language options
Options.CategoryOptions - Class in com.lexalytics.salience
Base class for Salience options that are more specific to categories
Options.ClassificationOptions - Class in com.lexalytics.salience
Base class for Salience options that are more specific to classifications
Options.CollectionOptions - Class in com.lexalytics.salience
Base class for Salience options that are more specific to collection-level functionality
Options.ConceptOptions - Class in com.lexalytics.salience
Base class for Salience options that are more specific to concept topic processing
Options.DocumentDetailsOptions - Class in com.lexalytics.salience
Base class for Salience options for configuring the Document Details output
Options.EntityOptions - Class in com.lexalytics.salience
Base class for Salience options that are more specific to entity extraction
Options.QueryTopicOptions - Class in com.lexalytics.salience
Base class for Salience options that are more specific to query topics
Options.ReinitializeOptions - Class in com.lexalytics.salience
Base class for Salience options that have been added to allow for reinitialization of specific engine functionality
Options.SentimentOptions - Class in com.lexalytics.salience
Base class for Salience options that are more specific to sentiment analysis
Options.SummaryOptions - Class in com.lexalytics.salience
Base class for Salience options that are more specific to summaries
Options.ThemeOptions - Class in com.lexalytics.salience
Base class for Salience options that are more specific to themes

P

Phrase - Class in com.lexalytics.salience
A span of text in a document.
Phrase(String, int, int, int, int, int, int, int, int, boolean, String, int, int, int, int) - Constructor for class com.lexalytics.salience.Phrase
Standard constructor for Phrase objects.
positive - com.lexalytics.salience.SentimentCategory
Used to indicate positive sentiment.
prepareCollectionFromFile(String, String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
prepareCollectionFromFile(String, String) - Method in class com.lexalytics.salience.SalienceCollections
Prepares a CSV file from disk for analysis.
prepareCollectionFromVector(String, Vector<String>) - Method in interface com.lexalytics.salience.ISalienceCollections
 
prepareCollectionFromVector(String, Vector<String>) - Method in class com.lexalytics.salience.SalienceCollections
Prepares the supplied collection for analysis.
prepareText(String) - Method in interface com.lexalytics.salience.ISalience
 
prepareText(String) - Method in class com.lexalytics.salience.Salience
Prepares the supplied document for analysis.
prepareTextFromFile(String) - Method in interface com.lexalytics.salience.ISalience
 
prepareTextFromFile(String) - Method in class com.lexalytics.salience.Salience
Prepares a document from disk for analysis.
PRONOMINAL - com.lexalytics.salience.Mention.MentionType
A reference to the item via pronoun

Q

QueryInfo - Class in com.lexalytics.salience
 
QueryInfo(boolean, String, String, int, int, int, int, int, int, int, int, int, int) - Constructor for class com.lexalytics.salience.QueryInfo
 
QueryTopicOptions() - Constructor for class com.lexalytics.salience.Options.QueryTopicOptions
 
QueryTopics - Variable in class com.lexalytics.salience.Options
 

R

Reinitialize - Variable in class com.lexalytics.salience.Options
 
ReinitializeOptions() - Constructor for class com.lexalytics.salience.Options.ReinitializeOptions
 
reinitializeThemes() - Method in class com.lexalytics.salience.Options.ReinitializeOptions
 
Relationship - Class in com.lexalytics.salience
A Relationship object represents a connection between one or more Entity objects.
Relationship(Vector<Entity>, String, String, String, float, Map<String, Set<Entity>>) - Constructor for class com.lexalytics.salience.Relationship
Creates a new relationship object.
removeSalienceConfiguration(String) - Method in interface com.lexalytics.salience.ISalience
 
removeSalienceConfiguration(String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
removeSalienceConfiguration(String) - Method in class com.lexalytics.salience.Salience
Remove a user directory session.
removeSalienceConfiguration(String) - Method in class com.lexalytics.salience.SalienceCollections
Remove a user directory session.
retrainModel(String, String, String, String) - Method in interface com.lexalytics.salience.ISalience
 
retrainModel(String, String, String, String) - Method in class com.lexalytics.salience.Salience
Takes an existing trained ML Model, adds newly provided data in the form of about .lexas annotation file (with corresponding classmap) and reruns the training of the model with the exact hyperparameters used to train it initially.
Row - Class in com.lexalytics.salience
A Row object represents a particular row from a list or table (which are represented by a Section.
Row(Vector<Sentence>) - Constructor for class com.lexalytics.salience.Row
Creates a new row.
RunModelSmokeTest(Vector<ModelSmokeTestReport>, Vector<ModelSmokeTestReport>, String) - Method in interface com.lexalytics.salience.ISalience
 
RunModelSmokeTest(Vector<ModelSmokeTestReport>, Vector<ModelSmokeTestReport>, String) - Method in class com.lexalytics.salience.Salience
 

S

Salience - Class in com.lexalytics.salience
The Salience object encapsulates the document-level text analytics functionality available from Salience Engine.
Salience(String, String) - Constructor for class com.lexalytics.salience.Salience
Creates a new Salience session.
Salience(String, String, boolean) - Constructor for class com.lexalytics.salience.Salience
Creates a new Salience session.
Salience(String, String, String) - Constructor for class com.lexalytics.salience.Salience
Creates a new Salience session.
Salience(String, String, String, boolean) - Constructor for class com.lexalytics.salience.Salience
Creates a new Salience session.
Salience(String, String, String, String, boolean) - Constructor for class com.lexalytics.salience.Salience
Creates a new Salience session.
SalienceCallback - Class in com.lexalytics.salience
The SalienceCallback class provides a method for receiving callback messages from the underlying API during certain operations.
SalienceCallback() - Constructor for class com.lexalytics.salience.SalienceCallback
 
SalienceCollections - Class in com.lexalytics.salience
The SalienceCollections object encapsulates the collection-level text analytics functionality available from Salience Engine.
SalienceCollections(String, String) - Constructor for class com.lexalytics.salience.SalienceCollections
Creates a new SalienceCollections session.
SalienceCollections(String, String, boolean) - Constructor for class com.lexalytics.salience.SalienceCollections
Creates a new SalienceCollections session.
SalienceCollections(String, String, String) - Constructor for class com.lexalytics.salience.SalienceCollections
Creates a new SalienceCollections session.
SalienceCollections(String, String, String, boolean) - Constructor for class com.lexalytics.salience.SalienceCollections
Creates a new SalienceCollections session.
SalienceCollections(String, String, String, String, boolean) - Constructor for class com.lexalytics.salience.SalienceCollections
Creates a new SalienceCollections session.
SalienceException - Exception in com.lexalytics.salience
Salience Engine encountered a problem and was unable to fulfill the request.
SalienceException(String) - Constructor for exception com.lexalytics.salience.SalienceException
 
Section - Class in com.lexalytics.salience
The Section object provides the statistical information about the document content determined by Salience.
Section(int, int, int, int, int, Map<String, Integer>, Map<String, Integer>, Map<String, Integer>, Map<String, Integer>, Map<String, Integer>, Map<String, Integer>, Map<String, Integer>, Map<String, Integer>, Map<String, Integer>, Vector<Sentence>, String, String, Vector<Row>, String) - Constructor for class com.lexalytics.salience.Section
Creates a new Section object.
Sentence - Class in com.lexalytics.salience
The Sentence object contains information about a single sentence in the document content.
Sentence(Vector<Word>, Vector<Chunk>, boolean, String, boolean, boolean, int, float) - Constructor for class com.lexalytics.salience.Sentence
Creates a new Sentence object.
Sentiment - Variable in class com.lexalytics.salience.Options
 
SentimentCategory - Enum in com.lexalytics.salience
This is an enumeration of the sentiment categories related to model-based sentiment analysis.
SentimentModelScores - Class in com.lexalytics.salience
The SentimentModelScores object is a member of the DocumentSentiment object and encapsulates model-based sentiment results.
SentimentOptions() - Constructor for class com.lexalytics.salience.Options.SentimentOptions
 
SentimentPhrase - Class in com.lexalytics.salience
A Phrase that contains sentiment.
SentimentPhrase(String, int, int, int, int, int, int, int, int, float, String, int, Vector<Phrase>, int, int, int) - Constructor for class com.lexalytics.salience.SentimentPhrase
Standard constructor for Phrase objects.
setAddClassificationModel(String) - Method in class com.lexalytics.salience.Options.ClassificationOptions
Added in Salience 6.2.1
String property that accepts a path (or comma delimited path list) of classification model directories and adds them to the current configuration
setAddEntityModel(String) - Method in class com.lexalytics.salience.Options.EntityOptions
Added in Salience 6.2.1
String property that accepts a path (or comma delimited path list) of entity model directories and adds them to the current configuration
setAllowInitialConjunction(boolean) - Method in class com.lexalytics.salience.Options.SummaryOptions
Whether to allow sentences into summary that begin with a conjunction.
setAllowThemeOverlap(boolean) - Method in class com.lexalytics.salience.Options.ThemeOptions
Added in Salience 6.2
Flag to control whether to allow themes that overlap in a document Min/Max range: true/false Default value: false
setAllSentimentPhrases(boolean) - Method in class com.lexalytics.salience.Options.SentimentOptions
Added in Salience 5.1
Enables the user to get all possible sentiment phrases back from GetSentiment, even ones that aren't in the dictionary.
setAllThemeMentions(boolean) - Method in class com.lexalytics.salience.Options.CollectionOptions
Added in Salience 5.1
Determines whether or not to return all theme mentions for collection themes Min/Max range: true/false Default value: true
setAlternateForms(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Added in Salience 6.0
Allows alternate forms during text analysis for Salience Min/Max range: true/false Short-mode default value true Long-mode default value false Enabling this option will allow the use of alternate forms.
setAnaphoraResolution(boolean) - Method in class com.lexalytics.salience.Options.EntityOptions
Controls the connecting of pronouns to entities Min/Max range: true/false Default value: true When set to true, Salience will connect entities to pronouns.
setBasicLanguageAddress(String) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
If you wish to run the Basic Language server on a different machine, set the ip address of it with this option.
setBasicLanguagePort(int) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
Basic languages are run as a separate local server.
setBasicLanguageServerCloseDelay(int) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
Seconds to wait for Basic Language server to close before restarting Only useful when Salience is managing the Basic Language server.
setBasicLanguageServerMaxRequestAttempts(int) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
How many times to retry a single request before restarting server.
setBasicLanguageServerMaxServerRestarts(int) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
How many times to try restarting the server.
setBasicLanguageServerOptions(String) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
Basic Language server command line options (e.g.
setBasicLanguageServerRequestAttemptDelay(int) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
Millisecs to wait between each request attempt.
setBasicLanguageServerRequestTimeout(int) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
Seconds to wait for a single Basic Language request.
setBasicLanguageServerStartupTimeout(int) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
Seconds to wait for Basic Language server to become healthy after starting process.
setBasicLanguageServerVersion(String) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
Basic Language server version (must be "v4").
setCalculateListsAndTables(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Added in Salience 5.1
Determine if content contains lists or tables.
setCategoryExplanation(boolean) - Method in class com.lexalytics.salience.Options.CategoryOptions
Added in Salience 5.1.1
When enabled, the terms leading to a category match are included in the result structure.
setChainedEntitySentiment(boolean) - Method in class com.lexalytics.salience.Options.SentimentOptions
Added in Salience 6.0
Switches between new, parse based entity sentiment and the previous, chain based version Min/Max range: true/false Default value: false Setting this value to true will return to the previous Salience sentiment algorithm
setClassificationThreshold(int) - Method in class com.lexalytics.salience.Options.ClassificationOptions
Added in Salience 6.0
Value from 1 to 100 controlling the threshold classification results must meet.
setClearClassificationModels() - Method in class com.lexalytics.salience.Options.ClassificationOptions
Added in Salience 6.2.1
String property that clears all loaded classification models
setClearEntityModels() - Method in class com.lexalytics.salience.Options.EntityOptions
Added in Salience 6.2.1
String property that clears all loaded entity models
setComplexStems(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Added in Salience 5.1
Enables more complicated stemming behavior.
setConceptSlop(float) - Method in class com.lexalytics.salience.Options.BaseOptions
Sets a threshold for the measure of similarity between two concepts for them to roll together.
setConceptTopicList(String) - Method in class com.lexalytics.salience.Options.ConceptOptions
Option to specify location of concept topic query file Min/Max range: n/a Default value: none Sets path to file containing concept topic definitions
setConceptTopicWindowJump(int) - Method in class com.lexalytics.salience.Options.ConceptOptions
Smooths out the concept topic window feature at a slight performance hit.
setConceptTopicWindowSize(int) - Method in class com.lexalytics.salience.Options.ConceptOptions
Smaller values will allow small, on-topic text to match concepts for the whole document Min/Max range: 0-50 Default value: 0
setContentHTML(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Added in Salience 5.1.1
Allows HTML content to be provided to Salience for text analysis Min/Max range: true/false Default value false By default, the content provided to Salience for processing must be plain text.
setCurrentOptionSession(String) - Method in class com.lexalytics.salience.Options.BaseOptions
Set this option first to specify which session subsequent options should be applied to.
setDefaultAcceptsNegated(boolean) - Method in class com.lexalytics.salience.Options.QueryTopicOptions
Boolean property specifying whether a negated term (e.g.
setDelimiter(String) - Method in class com.lexalytics.salience.Options.SummaryOptions
User can specify a custom delimiter for summaries.
setDiversity(float) - Method in class com.lexalytics.salience.Options.SummaryOptions
How strongly to encourage uniqueness in the sentences in a summary.
setDocDetailsStemming(boolean) - Method in class com.lexalytics.salience.Options.DocumentDetailsOptions
Added in Salience 5.2 Update
Controls whether term, bigram and trigram output should be stemmed Min/Max range: true/false Default value true Whether to combine and report the terms, bigrams and trigrams based on there stemmed versions or original text.
setEarlySentenceBonus(float) - Method in class com.lexalytics.salience.Options.SummaryOptions
Bonus to early sentences when generating summaries.
setEarlySentenceCount(int) - Method in class com.lexalytics.salience.Options.SummaryOptions
Number of sentences considered "early" when generating summaries Min: 0 Default value: 5
setEmphaticModifier(float) - Method in class com.lexalytics.salience.Options.SentimentOptions
Added in Salience 5.2
Enables the user to customize the sentiment modifier for emphatic sentences such as sentences with exclamations or repeated phrases.
setEntityOverlap(boolean) - Method in class com.lexalytics.salience.Options.EntityOptions
Sets whether User Entities can overlap each other.
setEntitySummaryLength(int) - Method in class com.lexalytics.salience.Options.EntityOptions
Sets length in number of sentences for an entity summary.
setEntityThemes(boolean) - Method in class com.lexalytics.salience.Options.EntityOptions
Added in Salience 6.1
If true, finds themes for entity.
setEntityThreshold(int) - Method in class com.lexalytics.salience.Options.EntityOptions
Controls how confident Salience must be to return an entity.
setEntityTopics(boolean) - Method in class com.lexalytics.salience.Options.EntityOptions
Added in Salience 5.1
Whether to calculate topic matches for all entities.
setFailLongSentence(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
When a document contains a very long sentence, should you process the rest of the document? (0=process) Min/Max range: true/false Default value: false
setFlattenAllUpperCase(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Added in Salience 5.1 (r6700)
If a sentence is encountered with all upper case tokens, it should get converted to lower case for better POS tagging Min/Max range: true/false Default value false Recommended use is when user's documents contain many sentences with all upper case tokens and wants consistent POS tagging across upper case and lower case letters.
setIdealLength(int) - Method in class com.lexalytics.salience.Options.SummaryOptions
Target summary sentence length Likely range: 0 (off), 8-15 Default value: 0
setIgnoreAccents(boolean) - Method in class com.lexalytics.salience.Options.EntityOptions
Added in Salience 6.2
Boolean property specifying whether queries without accents/diacritics should match content that has them.
setIgnoreAccents(boolean) - Method in class com.lexalytics.salience.Options.QueryTopicOptions
Boolean property specifying whether queries without accents/diacritics should match content that has them.
setLengthPenalty(float) - Method in class com.lexalytics.salience.Options.SummaryOptions
Penalty for deviating from target summary length.
setManualBasicLanguageMangement(boolean) - Method in class com.lexalytics.salience.Options.BasicLanguageOptions
Basic languages are run as a separate local server.
setMaxCollectionSize(int) - Method in class com.lexalytics.salience.Options.CollectionOptions
Maximum number of documents that can be included in a single collection Min/Max range: 0-MAX INT Default value: 50000 Larger collections will require more memory and longer processing time.
setMaxConceptTopicHits(int) - Method in class com.lexalytics.salience.Options.ConceptOptions
Limit of concept topic results to return.
setMaxExecutionTime(int) - Method in class com.lexalytics.salience.Options.BaseOptions
Maximum time in milliseconds certain functions are allowed to run for.
setMaxQueryLength(int) - Method in class com.lexalytics.salience.Options.QueryTopicOptions
Integer property specifying maximum length (in bytes) of a single topic query.
setMinConceptTopicScore(float) - Method in class com.lexalytics.salience.Options.ConceptOptions
Sets a lower bound on the score for a concept topic to be identified for a document Min/Max range: 0-1 Default value: 0.45 The score value for a concept topic hit must be greater than this setting in order for it to be considered a hit for the document.
setMinSentenceLength(int) - Method in class com.lexalytics.salience.Options.SummaryOptions
Exlcude sentences with fewer than this many tokens from consideration.
setModelSensitivity(float) - Method in class com.lexalytics.salience.Options.EntityOptions
Threshold for CRF model-based entity extraction.
setNongrammaticalTopics(boolean) - Method in class com.lexalytics.salience.Options.ConceptOptions
Flag to control definition of concept topics.
SetOption(int, boolean, String) - Method in interface com.lexalytics.salience.ISalience
 
SetOption(int, boolean, String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
SetOption(int, boolean, String) - Method in class com.lexalytics.salience.Salience
Sets an option that requires a boolean value.
SetOption(int, boolean, String) - Method in class com.lexalytics.salience.SalienceCollections
Sets an option that requires a boolean value.
SetOption(int, float, String) - Method in interface com.lexalytics.salience.ISalience
 
SetOption(int, float, String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
SetOption(int, float, String) - Method in class com.lexalytics.salience.Salience
Sets an option that requires a float value.
SetOption(int, float, String) - Method in class com.lexalytics.salience.SalienceCollections
Sets an option that requires a float value.
SetOption(int, int, String) - Method in interface com.lexalytics.salience.ISalience
 
SetOption(int, int, String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
SetOption(int, int, String) - Method in class com.lexalytics.salience.Salience
Sets an option that requires an integer value.
SetOption(int, int, String) - Method in class com.lexalytics.salience.SalienceCollections
Sets an option that requires an integer value.
SetOption(int, int, String, String) - Method in interface com.lexalytics.salience.ISalience
 
SetOption(int, int, String, String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
SetOption(int, int, String, String) - Method in class com.lexalytics.salience.Salience
Sets an option that requires a String value and an integer value.
SetOption(int, int, String, String) - Method in class com.lexalytics.salience.SalienceCollections
Sets an option that requires a String value and an integer value.
SetOption(int, String, String) - Method in interface com.lexalytics.salience.ISalience
 
SetOption(int, String, String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
SetOption(int, String, String) - Method in class com.lexalytics.salience.Salience
Sets an option that requires a String value.
SetOption(int, String, String) - Method in class com.lexalytics.salience.SalienceCollections
Sets an option that requires a String value.
SetOptionsWithFile(String, String) - Method in interface com.lexalytics.salience.ISalience
 
SetOptionsWithFile(String, String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
SetOptionsWithFile(String, String) - Method in class com.lexalytics.salience.Salience
Sets all options specified in the provided tab delimited file
SetOptionsWithFile(String, String) - Method in class com.lexalytics.salience.SalienceCollections
Sets all options specified in the provided tab delimited file
SetOptionWithString(String, String) - Method in interface com.lexalytics.salience.ISalience
 
SetOptionWithString(String, String) - Method in interface com.lexalytics.salience.ISalienceCollections
 
SetOptionWithString(String, String) - Method in class com.lexalytics.salience.Salience
Sets all options specified in the provided String
SetOptionWithString(String, String) - Method in class com.lexalytics.salience.SalienceCollections
Sets all options specified in the provided String
setOverlapSentimentThemes(boolean) - Method in class com.lexalytics.salience.Options.EntityOptions
Determines if LSF entries can include dictionary entries.
setPOSTagRestrictedHSDMatches(boolean) - Method in class com.lexalytics.salience.Options.SentimentOptions
Added in Salience 6.2
By default, Salience takes into account part of speech tags when determining if a phrase has sentiment.
setProcessAsOneSentence(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Added in Salience 5.1
Process entire document as single sentence.
setPronounPenalty(float) - Method in class com.lexalytics.salience.Options.SummaryOptions
Penalty for using pronouns in a sentence when selecting them for summaries.
setQueryTopicList(String) - Method in class com.lexalytics.salience.Options.QueryTopicOptions
String property specifying a path to file containing topic queries.
setQuotesIntact(boolean) - Method in class com.lexalytics.salience.Options.SummaryOptions
When enabled, if a sentence in a summary is part of a quote, the whole quote will be returned instead.
setRemoveClassificationModel(String) - Method in class com.lexalytics.salience.Options.ClassificationOptions
Added in Salience 6.2.1
String property that accepts a path (or comma delimited path list) of classification model directories and removes them from the current configuration if they had previously been loaded.
setRemoveEntityModel(String) - Method in class com.lexalytics.salience.Options.EntityOptions
Added in Salience 6.2.1
String property that accepts a path (or comma delimited path list) of entity model directories and removes them from the current configuration if they had previously been loaded.
setRequiredEntities(String) - Method in class com.lexalytics.salience.Options.EntityOptions
If set, only entities of the specified type (comma-delimited list) will be returned Min/Max range: n/a Default value: none
setResultSize(int) - Method in class com.lexalytics.salience.Options.CollectionOptions
Defines maximum number of results to return for collection functions such as facets or entities.
setSentimentDictionary(String) - Method in class com.lexalytics.salience.Options.SentimentOptions
Loads the phrases from the specified sentiment dictionary (HSD) for use in sentiment analysis.
SetSentimentThresholds(float, float) - Method in class com.lexalytics.salience.Options.SentimentOptions
Sets the boundaries for document sentiment to be considered neutral Min/Max range: MAX_FLOAT Default value: negativeMaximum = -0.45, positiveMaximum = 0.5 By default, the negative sentiment count for collection documents will represent documents scoring -0.45 or lower.
setSimpleSentimentCalculations(boolean) - Method in class com.lexalytics.salience.Options.SentimentOptions
Added in Salience 6.0
When enabled turns off various advanced sentiment calculations, resulting in inferior (but easier to understand) results.
setStemFacets(boolean) - Method in class com.lexalytics.salience.Options.CollectionOptions
Added in Salience 5.2
Controls stemming for facets and attributes Min/Max range: true/false Default value: true
setStemUserEntityContent(boolean) - Method in class com.lexalytics.salience.Options.EntityOptions
Added in Salience 5.2
Whether to stem the content provided when processing user entities.
setSuperlativeModifier(float) - Method in class com.lexalytics.salience.Options.SentimentOptions
Added in Salience 5.2
Enables the user to customize the sentiment modifier for superlatives Min/Max range: MAX_FLOAT Default value: 1.25 This option enables the user to customize the effect of superlatives.
setTaggingThreshold(int) - Method in class com.lexalytics.salience.Options.BaseOptions
Sets threshold of percentage of alphanumeric characters for text processing.
setThemeTopics(boolean) - Method in class com.lexalytics.salience.Options.ThemeOptions
Added in Salience 5.1
Flag to control whether or not to calculate topic matches for themes Min/Max range: true/false Default value: false
setTopicStemming(boolean) - Method in class com.lexalytics.salience.Options.QueryTopicOptions
Boolean property indicating whether stemming should be applied to topic queries.
setUseChainer(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Added in Salience 6.0
Allows you to turn on and off our lexical chaining algorithm, which improves accuracy at a runtime performance cost Disabling also makes the reason results were generated little clearer.
setUseChunkParser(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Added in Salience 6.4
Turns on/off the chunk parser.
setUseOCRContext(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Added in Salience 6.7
Turns on/off the use of context in OCR error correction.
setUsePolarityModel(boolean) - Method in class com.lexalytics.salience.Options.SentimentOptions
Added in Salience 5.1
Includes a measure of whether a sentence 'looks' like the sort of sentence that usually communicates sentiment in analysis.
setUserDirectory(String) - Method in class com.lexalytics.salience.Options.BaseOptions
Sets path to user directory of customizations Min/Max range: n/a Default value: [path to data directory specified on init]/user
setUserDirectoryOnly(boolean) - Method in class com.lexalytics.salience.Options.EntityOptions
Added in Salience 5.2
When turned on, allows named entities to operate using only the files from user/salience/entities rather than both the user and the data folders.
setUserEntityList(String) - Method in class com.lexalytics.salience.Options.EntityOptions
Path to user-defined entity list.
setUserSentimentPhrasesOnly(boolean) - Method in class com.lexalytics.salience.Options.SentimentOptions
Added in Salience 6.2
While we recommend laying your own sentiment tuning on top of our existing sentiment phrases, you may occasionally want documents scored only against an explicit list of phrases you provide.
setUseSemantics(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Use concept matrix for themes on a per document basis.
setUseSemantics(boolean) - Method in class com.lexalytics.salience.Options.CollectionOptions
Determines whether or not to utilize the concept matrix during collection operations Min/Max range: true/false Default value: true Concept matrix functionality is used for concept topics as well as the rollup of themes and facets at the collection level.
setUseSharedMemory(boolean) - Method in class com.lexalytics.salience.Options.BaseOptions
Added in Salience 5.1
Puts large data files into interprocess space for a smaller overall footprint.
Summaries - Variable in class com.lexalytics.salience.Options
 
Summary - Class in com.lexalytics.salience
The Summary object provides a brief summary about the document content determined by Salience.
Summary(String, Vector<Sentence>, String, Vector<Sentence>) - Constructor for class com.lexalytics.salience.Summary
Creates a new Summary object.
SummaryOptions() - Constructor for class com.lexalytics.salience.Options.SummaryOptions
 

T

Theme - Class in com.lexalytics.salience
A theme represents a general idea expressed in content.
Theme(String, String, String, float, boolean, float, int, boolean, String, Vector<Phrase>, Vector<Topic>, Vector<AlternateTheme>, Vector<Phrase>, Vector<Phrase>) - Constructor for class com.lexalytics.salience.Theme
Creates a new theme.
ThemeOptions() - Constructor for class com.lexalytics.salience.Options.ThemeOptions
 
Themes - Variable in class com.lexalytics.salience.Options
 
Topic - Class in com.lexalytics.salience
A topic is a label associated with a document.
Topic(String, int, float, float, int, String, boolean, Vector<Topic>, Vector<Entity>, Vector<Phrase>, Vector<SentimentPhrase>) - Constructor for class com.lexalytics.salience.Topic
Creates a new topic.

V

valueOf(String) - Static method in enum com.lexalytics.salience.ISalience.Warning
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.lexalytics.salience.ISalienceCollections.Warning
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.lexalytics.salience.Mention.MentionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.lexalytics.salience.SentimentCategory
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.lexalytics.salience.ISalience.Warning
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.lexalytics.salience.ISalienceCollections.Warning
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.lexalytics.salience.Mention.MentionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.lexalytics.salience.SentimentCategory
Returns an array containing the constants of this enum type, in the order they are declared.

W

Word - Class in com.lexalytics.salience
A Word object represents a token in the content being processed in Salience.
Word(String, String, String, float, boolean, boolean, int, int, int, int) - Constructor for class com.lexalytics.salience.Word
Creates a new Word.
A B C D E F G I L M N O P Q R S T V W 
All Classes All Packages