com.exalead.indexing.analysis.v10

Class SentimentAnalyzer

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.SentimentAnalyzer

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class SentimentAnalyzer
extends SemanticProcessor
implements com.exalead.util.Checkable, java.io.Serializable

Analyzes the nouns and adjectives present in the text. It detects topics and annotates the document with:

• a global rating of good, bad or neutral
• a rating per topic
• the adjective(s) used in the document

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

SemanticProcessor.FromDataModel, SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
boolean	annotateGlobally
boolean	annotatePronouns
static boolean	DEFAULT_ANNOTATE_GLOBALLY
static boolean	DEFAULT_ANNOTATE_PRONOUNS
static boolean	DEFAULT_IGNORE_PART_OF_SPEECH
static boolean	DEFAULT_IGNORE_RELATED_TERMS
static boolean	DEFAULT_LEGACY_ANNOTATIONS
static boolean	DEFAULT_NORMALIZE_TRUST_LEVELS
static boolean	DEFAULT_NOT_APPLICABLE_ANNOTATIONS
static boolean	DEFAULT_NOUN_PACKAGE
static boolean	DEFAULT_PACKAGE_COUNT
static boolean	DEFAULT_SHOW_PACKAGE
static boolean	DEFAULT_SUGGEST
static boolean	DEFAULT_SUMMARIZE
boolean	ignorePartOfSpeech
boolean	ignoreRelatedTerms
java.lang.String	language
boolean	legacyAnnotations
boolean	normalizeTrustLevels
boolean	notApplicableAnnotations
boolean	nounPackage Deprecated.
boolean	packageCount
java.lang.String	resourceDir
boolean	showPackage
boolean	suggest
java.lang.String	suggestOutput
boolean	summarize

Fields inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

contexts, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

Constructor and Description
SentimentAnalyzer()
SentimentAnalyzer(SentimentAnalyzer o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(SemanticProcessor.Transformer<T> transformer, T[] t)
void	accept(SemanticProcessor.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this SentimentAnalyzer.
static SentimentAnalyzer	fromString(java.lang.String s) String representation of this SentimentAnalyzer.
java.lang.String	getLanguage()
java.lang.String	getResourceDir() URL for the resource (data://, file;// or resource://).
java.lang.String	getSuggestOutput()
boolean	isAnnotateGlobally()
boolean	isAnnotatePronouns()
boolean	isIgnorePartOfSpeech()
boolean	isIgnoreRelatedTerms()
boolean	isLegacyAnnotations()
boolean	isNormalizeTrustLevels()
boolean	isNotApplicableAnnotations()
boolean	isNounPackage() Deprecated.
boolean	isPackageCount()
boolean	isShowPackage()
boolean	isSuggest()
boolean	isSummarize()
SentimentAnalyzer	makeCopy() Creates and returns a deep copy of this SentimentAnalyzer.
static SentimentAnalyzer	readFrom(java.io.InputStream is) Read this SentimentAnalyzer from an XML fragment.
void	setAnnotateGlobally(boolean annotateGlobally)
void	setAnnotatePronouns(boolean annotatePronouns)
void	setIgnorePartOfSpeech(boolean ignorePartOfSpeech)
void	setIgnoreRelatedTerms(boolean ignoreRelatedTerms)
void	setLanguage(java.lang.String language)
void	setLegacyAnnotations(boolean legacyAnnotations)
void	setNormalizeTrustLevels(boolean normalizeTrustLevels)
void	setNotApplicableAnnotations(boolean notApplicableAnnotations)
void	setNounPackage(boolean nounPackage) Deprecated.
void	setPackageCount(boolean packageCount)
void	setResourceDir(java.lang.String resourceDir) URL for the resource (data://, file;// or resource://).
void	setShowPackage(boolean showPackage)
void	setSuggest(boolean suggest)
void	setSuggestOutput(java.lang.String suggestOutput)
void	setSummarize(boolean summarize)
java.lang.String	toString() String representation of this SentimentAnalyzer.
SentimentAnalyzer	withAnnotateGlobally(boolean annotateGlobally)
SentimentAnalyzer	withAnnotateGlobally(java.lang.Boolean annotateGlobally)
SentimentAnalyzer	withAnnotatePronouns(boolean annotatePronouns)
SentimentAnalyzer	withAnnotatePronouns(java.lang.Boolean annotatePronouns)
SentimentAnalyzer	withContexts(java.lang.String contexts)
SentimentAnalyzer	withDataModelClass(java.lang.String dataModelClass)
SentimentAnalyzer	withDataModelProperty(java.lang.String dataModelProperty)
SentimentAnalyzer	withDataModelState(java.lang.String dataModelState)
SentimentAnalyzer	withDisabled(boolean disabled)
SentimentAnalyzer	withDisabled(java.lang.Boolean disabled)
SentimentAnalyzer	withFromDataModel(SemanticProcessor fromDataModel)
SentimentAnalyzer	withIgnorePartOfSpeech(boolean ignorePartOfSpeech)
SentimentAnalyzer	withIgnorePartOfSpeech(java.lang.Boolean ignorePartOfSpeech)
SentimentAnalyzer	withIgnoreRelatedTerms(boolean ignoreRelatedTerms)
SentimentAnalyzer	withIgnoreRelatedTerms(java.lang.Boolean ignoreRelatedTerms)
SentimentAnalyzer	withLanguage(java.lang.String language)
SentimentAnalyzer	withLegacyAnnotations(boolean legacyAnnotations)
SentimentAnalyzer	withLegacyAnnotations(java.lang.Boolean legacyAnnotations)
SentimentAnalyzer	withName(java.lang.String name)
SentimentAnalyzer	withNormalizeTrustLevels(boolean normalizeTrustLevels)
SentimentAnalyzer	withNormalizeTrustLevels(java.lang.Boolean normalizeTrustLevels)
SentimentAnalyzer	withNotApplicableAnnotations(boolean notApplicableAnnotations)
SentimentAnalyzer	withNotApplicableAnnotations(java.lang.Boolean notApplicableAnnotations)
SentimentAnalyzer	withNounPackage(boolean nounPackage) Deprecated.
SentimentAnalyzer	withNounPackage(java.lang.Boolean nounPackage) Deprecated.
SentimentAnalyzer	withPackageCount(boolean packageCount)
SentimentAnalyzer	withPackageCount(java.lang.Boolean packageCount)
SentimentAnalyzer	withResourceDir(java.lang.String resourceDir)
SentimentAnalyzer	withShowPackage(boolean showPackage)
SentimentAnalyzer	withShowPackage(java.lang.Boolean showPackage)
SentimentAnalyzer	withSuggest(boolean suggest)
SentimentAnalyzer	withSuggest(java.lang.Boolean suggest)
SentimentAnalyzer	withSuggestOutput(java.lang.String suggestOutput)
SentimentAnalyzer	withSummarize(boolean summarize)
SentimentAnalyzer	withSummarize(java.lang.Boolean summarize)
void	writeTo(java.io.OutputStream os) Write this SentimentAnalyzer as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

getContexts, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setContexts, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

resourceDir

public java.lang.String resourceDir

language

public java.lang.String language

annotateGlobally

public boolean annotateGlobally

DEFAULT_ANNOTATE_GLOBALLY

public static final boolean DEFAULT_ANNOTATE_GLOBALLY

See Also:

Constant Field Values

annotatePronouns

public boolean annotatePronouns

DEFAULT_ANNOTATE_PRONOUNS

public static final boolean DEFAULT_ANNOTATE_PRONOUNS

See Also:

Constant Field Values

ignorePartOfSpeech

public boolean ignorePartOfSpeech

DEFAULT_IGNORE_PART_OF_SPEECH

public static final boolean DEFAULT_IGNORE_PART_OF_SPEECH

See Also:

Constant Field Values

ignoreRelatedTerms

public boolean ignoreRelatedTerms

DEFAULT_IGNORE_RELATED_TERMS

public static final boolean DEFAULT_IGNORE_RELATED_TERMS

See Also:

Constant Field Values

legacyAnnotations

public boolean legacyAnnotations

DEFAULT_LEGACY_ANNOTATIONS

public static final boolean DEFAULT_LEGACY_ANNOTATIONS

See Also:

Constant Field Values

notApplicableAnnotations

public boolean notApplicableAnnotations

DEFAULT_NOT_APPLICABLE_ANNOTATIONS

public static final boolean DEFAULT_NOT_APPLICABLE_ANNOTATIONS

See Also:

Constant Field Values

normalizeTrustLevels

public boolean normalizeTrustLevels

DEFAULT_NORMALIZE_TRUST_LEVELS

public static final boolean DEFAULT_NORMALIZE_TRUST_LEVELS

See Also:

Constant Field Values

nounPackage

@Deprecated
public boolean nounPackage

Deprecated.

DEFAULT_NOUN_PACKAGE

public static final boolean DEFAULT_NOUN_PACKAGE

See Also:

Constant Field Values

packageCount

public boolean packageCount

DEFAULT_PACKAGE_COUNT

public static final boolean DEFAULT_PACKAGE_COUNT

See Also:

Constant Field Values

showPackage

public boolean showPackage

DEFAULT_SHOW_PACKAGE

public static final boolean DEFAULT_SHOW_PACKAGE

See Also:

Constant Field Values

suggest

public boolean suggest

DEFAULT_SUGGEST

public static final boolean DEFAULT_SUGGEST

See Also:

Constant Field Values

summarize

public boolean summarize

DEFAULT_SUMMARIZE

public static final boolean DEFAULT_SUMMARIZE

See Also:

Constant Field Values

suggestOutput

public java.lang.String suggestOutput

Constructor Detail

SentimentAnalyzer

public SentimentAnalyzer()

SentimentAnalyzer

public SentimentAnalyzer(SentimentAnalyzer o)

Copy constructor

Method Detail

withName

public SentimentAnalyzer withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public SentimentAnalyzer withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withFromDataModel

public SentimentAnalyzer withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public SentimentAnalyzer withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public SentimentAnalyzer withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public SentimentAnalyzer withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public SentimentAnalyzer withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public SentimentAnalyzer withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setResourceDir

public void setResourceDir(java.lang.String resourceDir)

URL for the resource (data://, file;// or resource://).

getResourceDir

public java.lang.String getResourceDir()

URL for the resource (data://, file;// or resource://).

withResourceDir

public SentimentAnalyzer withResourceDir(java.lang.String resourceDir)

setLanguage

public void setLanguage(java.lang.String language)

getLanguage

public java.lang.String getLanguage()

withLanguage

public SentimentAnalyzer withLanguage(java.lang.String language)

setAnnotateGlobally

public void setAnnotateGlobally(boolean annotateGlobally)

isAnnotateGlobally

public boolean isAnnotateGlobally()

withAnnotateGlobally

public SentimentAnalyzer withAnnotateGlobally(boolean annotateGlobally)

withAnnotateGlobally

public SentimentAnalyzer withAnnotateGlobally(java.lang.Boolean annotateGlobally)

setAnnotatePronouns

public void setAnnotatePronouns(boolean annotatePronouns)

isAnnotatePronouns

public boolean isAnnotatePronouns()

withAnnotatePronouns

public SentimentAnalyzer withAnnotatePronouns(boolean annotatePronouns)

withAnnotatePronouns

public SentimentAnalyzer withAnnotatePronouns(java.lang.Boolean annotatePronouns)

setIgnorePartOfSpeech

public void setIgnorePartOfSpeech(boolean ignorePartOfSpeech)

isIgnorePartOfSpeech

public boolean isIgnorePartOfSpeech()

withIgnorePartOfSpeech

public SentimentAnalyzer withIgnorePartOfSpeech(boolean ignorePartOfSpeech)

withIgnorePartOfSpeech

public SentimentAnalyzer withIgnorePartOfSpeech(java.lang.Boolean ignorePartOfSpeech)

setIgnoreRelatedTerms

public void setIgnoreRelatedTerms(boolean ignoreRelatedTerms)

isIgnoreRelatedTerms

public boolean isIgnoreRelatedTerms()

withIgnoreRelatedTerms

public SentimentAnalyzer withIgnoreRelatedTerms(boolean ignoreRelatedTerms)

withIgnoreRelatedTerms

public SentimentAnalyzer withIgnoreRelatedTerms(java.lang.Boolean ignoreRelatedTerms)

setLegacyAnnotations

public void setLegacyAnnotations(boolean legacyAnnotations)

isLegacyAnnotations

public boolean isLegacyAnnotations()

withLegacyAnnotations

public SentimentAnalyzer withLegacyAnnotations(boolean legacyAnnotations)

withLegacyAnnotations

public SentimentAnalyzer withLegacyAnnotations(java.lang.Boolean legacyAnnotations)

setNotApplicableAnnotations

public void setNotApplicableAnnotations(boolean notApplicableAnnotations)

isNotApplicableAnnotations

public boolean isNotApplicableAnnotations()

withNotApplicableAnnotations

public SentimentAnalyzer withNotApplicableAnnotations(boolean notApplicableAnnotations)

withNotApplicableAnnotations

public SentimentAnalyzer withNotApplicableAnnotations(java.lang.Boolean notApplicableAnnotations)

setNormalizeTrustLevels

public void setNormalizeTrustLevels(boolean normalizeTrustLevels)

isNormalizeTrustLevels

public boolean isNormalizeTrustLevels()

withNormalizeTrustLevels

public SentimentAnalyzer withNormalizeTrustLevels(boolean normalizeTrustLevels)

withNormalizeTrustLevels

public SentimentAnalyzer withNormalizeTrustLevels(java.lang.Boolean normalizeTrustLevels)

setNounPackage

@Deprecated
public void setNounPackage(boolean nounPackage)

Deprecated.

isNounPackage

@Deprecated
public boolean isNounPackage()

Deprecated.

withNounPackage

@Deprecated
public SentimentAnalyzer withNounPackage(boolean nounPackage)

Deprecated.

withNounPackage

@Deprecated
public SentimentAnalyzer withNounPackage(java.lang.Boolean nounPackage)

Deprecated.

setPackageCount

public void setPackageCount(boolean packageCount)

isPackageCount

public boolean isPackageCount()

withPackageCount

public SentimentAnalyzer withPackageCount(boolean packageCount)

withPackageCount

public SentimentAnalyzer withPackageCount(java.lang.Boolean packageCount)

setShowPackage

public void setShowPackage(boolean showPackage)

isShowPackage

public boolean isShowPackage()

withShowPackage

public SentimentAnalyzer withShowPackage(boolean showPackage)

withShowPackage

public SentimentAnalyzer withShowPackage(java.lang.Boolean showPackage)

setSuggest

public void setSuggest(boolean suggest)

isSuggest

public boolean isSuggest()

withSuggest

public SentimentAnalyzer withSuggest(boolean suggest)

withSuggest

public SentimentAnalyzer withSuggest(java.lang.Boolean suggest)

setSummarize

public void setSummarize(boolean summarize)

isSummarize

public boolean isSummarize()

withSummarize

public SentimentAnalyzer withSummarize(boolean summarize)

withSummarize

public SentimentAnalyzer withSummarize(java.lang.Boolean summarize)

setSuggestOutput

public void setSuggestOutput(java.lang.String suggestOutput)

getSuggestOutput

public java.lang.String getSuggestOutput()

withSuggestOutput

public SentimentAnalyzer withSuggestOutput(java.lang.String suggestOutput)

makeCopy

public SentimentAnalyzer makeCopy()

Creates and returns a deep copy of this SentimentAnalyzer.

Overrides:

makeCopy in class SemanticProcessor

readFrom

public static SentimentAnalyzer readFrom(java.io.InputStream is)
                                  throws javax.xml.bind.JAXBException

Read this SentimentAnalyzer from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this SentimentAnalyzer as an XML fragment

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static SentimentAnalyzer fromString(java.lang.String s)
                                    throws javax.xml.bind.JAXBException,
                                           java.io.UnsupportedEncodingException

String representation of this SentimentAnalyzer.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SentimentAnalyzer.

Overrides:

toString in class SemanticProcessor

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this SentimentAnalyzer.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public void accept(SemanticProcessor.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(SemanticProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException