com.ibm.watson.developer_cloud.document_conversion.v1.helpers

Class ConvertDocumentHelper

java.lang.Object

com.ibm.watson.developer_cloud.document_conversion.v1.helpers.ConvertDocumentHelper

public class ConvertDocumentHelper
extends Object

Helper class for all convert document API calls NOTE: The methods in this class should not be called directly! Please make all calls to the service using the DocumentConversion class.

See Also:

DocumentConversion

Constructor Summary

Constructors

Constructor and Description
ConvertDocumentHelper(DocumentConversion docConversionService) Sets the service object.

Method Summary

Modifier and Type	Method and Description
InputStream	convertDocument(File document, ConversionTarget conversionTarget) Synchronously converts a new document without persistence POST /v1/convert_document.
InputStream	convertDocument(File document, String mediaType, ConversionTarget conversionTarget) Synchronously converts a new document without persistence POST /v1/convert_document.
InputStream	convertDocument(String documentId, ConversionTarget conversionTarget) Synchronously converts a single previously uploaded document POST /v1/convert_document.
Answers	convertDocumentToAnswer(File document) Converts the provided document to an Answers object.
Answers	convertDocumentToAnswer(String documentId) Converts the specified document to an Answers object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvertDocumentHelper

public ConvertDocumentHelper(DocumentConversion docConversionService)

Sets the service object.

Parameters:

docConversionService - the doc conversion service

Method Detail

convertDocumentToAnswer

public Answers convertDocumentToAnswer(File document)

Converts the provided document to an Answers object.

Parameters:

document - the document

Returns:

Answers

See Also:

DocumentConversion.convertDocumentToAnswer(File)

convertDocument

public InputStream convertDocument(File document,
                                   ConversionTarget conversionTarget)

Synchronously converts a new document without persistence POST /v1/convert_document.

Parameters:

document - The file to convert

conversionTarget - The conversion target to use

Returns:

Converted document in the specified format

See Also:

DocumentConversion.convertDocument(File, ConversionTarget)

convertDocument

public InputStream convertDocument(File document,
                                   String mediaType,
                                   ConversionTarget conversionTarget)

Synchronously converts a new document without persistence POST /v1/convert_document.

Parameters:

document - The file to convert

mediaType - Internet media type for the file

conversionTarget - The conversion target to use

Returns:

Converted document in the specified format

See Also:

DocumentConversion.convertDocument(File, String, ConversionTarget)

convertDocumentToAnswer

public Answers convertDocumentToAnswer(String documentId)

Converts the specified document to an Answers object.

Parameters:

documentId - the document id

Returns:

Answers

See Also:

DocumentConversion.convertDocumentToAnswer(String)

convertDocument

public InputStream convertDocument(String documentId,
                                   ConversionTarget conversionTarget)

Synchronously converts a single previously uploaded document POST /v1/convert_document.

Parameters:

documentId - The id of the document to convert

conversionTarget - The conversion target to use

Returns:

Converted document in the specified format

See Also:

DocumentConversion.convertDocument(String, ConversionTarget)