com.hp.autonomy.hod.client.api.analysis.sentiment.SentimentAnalysisService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-hod-client Show documentation
Java Client for communicating with HP Haven OnDemand
There is a newer version: 0.25.3
/*
 * Copyright 2015-2016 Hewlett-Packard Development Company, L.P.
 * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
 */

package com.hp.autonomy.hod.client.api.analysis.sentiment;

import com.hp.autonomy.hod.client.api.authentication.TokenType;
import com.hp.autonomy.hod.client.error.HodErrorException;
import com.hp.autonomy.hod.client.token.TokenProxy;

import java.io.File;
import java.io.InputStream;

/**
 * Interface representing the SentimentAnalysis API
 */
public interface SentimentAnalysisService {

    /**
     * Analyze the sentiment of the given text using a token proxy provided by a {@link com.hp.autonomy.hod.client.token.TokenProxyService}
     * @param text The text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws HodErrorException
     * @throws NullPointerException If a TokenProxyService has not been defined
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForText(
        String text,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given text using the given token proxy
     * @param tokenProxy The token proxy to use to authenticate the request
     * @param text The text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForText(
        TokenProxy tokenProxy,
        String text,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given file using a token proxy provided by a {@link com.hp.autonomy.hod.client.token.TokenProxyService}
     * @param file The file containing the text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws NullPointerException If a TokenProxyService has not been defined
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForFile(
        File file,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given file using the given token proxy
     * @param tokenProxy The token proxy to use to authenticate the request
     * @param file The file containing the text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForFile(
        TokenProxy tokenProxy,
        File file,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given file using a token proxy provided by a {@link com.hp.autonomy.hod.client.token.TokenProxyService}
     * @param bytes The bytes of a file containing the text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws NullPointerException If a TokenProxyService has not been defined
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForFile(
        byte[] bytes,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given file using the given token proxy
     * @param tokenProxy The token proxy to use to authenticate the request
     * @param bytes The bytes of a file containing the text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForFile(
        TokenProxy tokenProxy,
        byte[] bytes,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given file using a token proxy provided by a {@link com.hp.autonomy.hod.client.token.TokenProxyService}
     * @param inputStream An InputStream representing a file containing the text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws NullPointerException If a TokenProxyService has not been defined
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForFile(
        InputStream inputStream,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given file using the given token proxy
     * @param tokenProxy The token proxy to use to authenticate the request
     * @param inputStream An InputStream representing a file containing the text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForFile(
        TokenProxy tokenProxy,
        InputStream inputStream,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given object store object using a token proxy provided by a {@link com.hp.autonomy.hod.client.token.TokenProxyService}
     * @param reference The object store reference containing the text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws NullPointerException If a TokenProxyService has not been defined
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForReference(
        String reference,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given object store object using the given token proxy
     * @param tokenProxy The token proxy to use to authenticate the request
     * @param reference The object store reference containing the text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForReference(
        TokenProxy tokenProxy,
        String reference,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given url using a token proxy provided by a {@link com.hp.autonomy.hod.client.token.TokenProxyService}
     * @param url The object store reference containing the text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws NullPointerException If a TokenProxyService has not been defined
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForUrl(
        String url,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

    /**
     * Analyze the sentiment of the given url using the given token proxy
     * @param tokenProxy The token proxy to use to authenticate the request
     * @param url The object store reference containing the text to analyze
     * @param language The language of the text
     * @return The sentiment of the response
     * @throws com.hp.autonomy.hod.client.api.authentication.HodAuthenticationFailedException If the token associated
     * with the token proxy has expired
     */
    SentimentAnalysisResponse analyzeSentimentForUrl(
        TokenProxy tokenProxy,
        String url,
        SentimentAnalysisLanguage language
    ) throws HodErrorException;

}