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

Class DocumentHelper

java.lang.Object

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

public class DocumentHelper
extends Object

Helper for the 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
DocumentHelper(DocumentConversion docConversionService) Sets the service object.

Method Summary

Modifier and Type	Method and Description
InputStream	getDocument(String documentId) Retrieves a document from the store with the given id GET /v1/documents/{document_id}.
DocumentCollection	getDocumentCollection(Map<String,Object> docListParams) Gets a collection of all existing documents with optional query parameters for filtering results.
Document	uploadDocument(File document) Uploads the document to the store with the given media type POST /v1/documents.
Document	uploadDocument(File document, String mediaType) Uploads the document to the store with the given media type POST /v1/documents.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentHelper

public DocumentHelper(DocumentConversion docConversionService)

Sets the service object.

Parameters:

docConversionService - the doc conversion service

Method Detail

getDocument

public InputStream getDocument(String documentId)

Retrieves a document from the store with the given id GET /v1/documents/{document_id}.

Parameters:

documentId - id of the document to be retrieved

Returns:

requested Document

See Also:

DocumentConversion.getDocument(String)

uploadDocument

public Document uploadDocument(File document)

Uploads the document to the store with the given media type POST /v1/documents.

Parameters:

document - the document to be uploaded

Returns:

Document

See Also:

DocumentConversion.uploadDocument(File)

uploadDocument

public Document uploadDocument(File document,
                               String mediaType)

Uploads the document to the store with the given media type POST /v1/documents.

Parameters:

document - the document to be uploaded

mediaType - the Internet media type for the file

Returns:

Document

See Also:

DocumentConversion.uploadDocument(File, String)

getDocumentCollection

public DocumentCollection getDocumentCollection(Map<String,Object> docListParams)

Gets a collection of all existing documents with optional query parameters for filtering results. GET /v1/documents

Parameters:

docListParams - The parameters to be used in the documents list service call. The parameters - token, limit, name, since and media_type are optional

• String token - The reference to the starting element of the requested page which is provided by the server, pass null to get the first page
• int limit - The number of documents to get, pass 0 to use the default limit from server (100)
• String name - The name of the documents to get, pass null to exclude this filter
• Date since - The date to filter on, documents created on or after the provided date and time format will be returned, pass null to exclude this filter
• String media_type - The Internet media type to filter on, pass null to exclude this filter

Returns:

Documents based on filtering parameters provided

See Also:

DocumentConversion.getDocumentCollection(Map)