|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.canoris.api.CanorisResourceManager
public class CanorisResourceManager
This class is the main communication point with the back-end. Through this class you can perform all the operation the back-end offers.
Constructor Summary | |
---|---|
CanorisResourceManager()
|
Method Summary | |
---|---|
void |
addFileToCollection(java.lang.String collectionKey,
CanorisFile file)
Adds a file to the given collection. |
void |
configProxy(java.lang.String host,
int port,
java.lang.String protocol)
Configures the proxy |
java.util.Map<java.lang.String,java.lang.Object> |
createCollection(java.lang.String name,
java.lang.String license,
java.lang.String visibility)
|
CanorisResource |
createFile(java.lang.String filePath,
java.util.Map<java.lang.String,java.lang.String> params)
Creates a file resource. |
CanorisResource |
createFileFromURL(java.lang.String url,
java.util.Map<java.lang.String,java.lang.String> params)
Creates a file from the URL parameter. |
java.util.Map<java.lang.String,java.lang.Object> |
createTask(java.lang.String taskName,
java.lang.String taskContent)
Creates with the give taskName, containing the taskContent. |
org.codehaus.jackson.JsonNode |
createTemplate(java.lang.String templateName,
java.lang.String templateContent)
Creates a template and returns the response or null TODO: This should return a JsonNode?? |
void |
deleteCollection(java.lang.String collectionKey)
Deletes the collection. |
void |
deleteTemplate(java.lang.String templateName)
Deletes the give template |
java.io.InputStream |
downloadFile(CanorisFile file)
Return an InputStream representing the requested file. |
java.io.InputStream |
downloadFile(java.lang.String fileKey)
Return an InputStream representing the requested file. |
org.codehaus.jackson.JsonNode |
getAnalysis(CanorisFile file,
java.lang.String filter)
Returns the analysis of the file as a JsonNode |
org.codehaus.jackson.JsonNode |
getAnalysisFrames(java.lang.String fileKey)
Returns the analysis frames |
java.util.Map<java.lang.String,java.lang.Object> |
getCollection(java.lang.String collectionKey)
|
java.util.Map<java.lang.String,java.lang.Object> |
getCollectionFile(java.lang.String collectionKey,
CanorisFile file)
|
Pager |
getCollectionFiles(java.lang.String collectionKey)
Returns a Pager. |
Pager |
getCollections()
|
java.io.InputStream |
getConversion(CanorisFile file,
java.lang.String conversionName)
Returns an input stream representing the conversion type requested. |
java.util.Map<java.lang.String,java.lang.Object> |
getConversions(CanorisFile file)
Gets the conversions of the file you pass |
CanorisFile |
getFile(CanorisFile file)
Returns a Map representing the requested file. |
CanorisFile |
getFile(java.lang.String fileKey)
Returns a Map representing the requested file. |
Pager |
getFiles()
Returns a Pager object to be used for navigating the pages or accessing a particular element in the page. |
Pager |
getNextPage(Pager pager)
Gets the next page. |
Pager |
getPage(Pager pager)
Gets the requested page. |
Pager |
getPage(java.lang.String start,
java.lang.String limit)
Gets the requested page. |
Pager |
getPreviousPage(Pager pager)
Gets the previous page. |
java.util.Map<java.lang.String,java.lang.Object> |
getSimilaritySearch(java.lang.String collectionKey,
CanorisFile file,
java.lang.String preset,
java.lang.String results)
Performs a similarity search. |
java.util.Map<java.lang.String,java.lang.Object> |
getTask(java.lang.String taskId)
Get the task that corresponds to the taskId. |
org.codehaus.jackson.JsonNode |
getTemplates()
Gets the list of templates. |
java.util.Map<java.lang.String,java.lang.Object> |
getText2Phon(java.lang.String text,
java.lang.String language)
|
java.io.InputStream |
getVisualization(CanorisFile file,
java.lang.String name)
Gets the visualization of the passed file |
java.util.Map<java.lang.String,java.lang.Object> |
getVisualizations(CanorisFile file)
Return the visualization of the file |
org.codehaus.jackson.JsonNode |
updateTemplate(java.lang.String templateContent,
java.lang.String templateName)
Updates the template that matches the templateName. |
void |
useProxy(boolean useProxy)
Sets if the communication uses a proxy or not |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CanorisResourceManager()
Method Detail |
---|
public CanorisResource createFile(java.lang.String filePath, java.util.Map<java.lang.String,java.lang.String> params) throws org.apache.http.client.ClientProtocolException, java.net.URISyntaxException, java.io.IOException
filePath
- params
-
org.apache.http.client.ClientProtocolException
java.net.URISyntaxException
java.io.IOException
public CanorisResource createFileFromURL(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> params) throws org.apache.http.client.ClientProtocolException, java.net.URISyntaxException, java.io.IOException, CanorisException
url
- params
-
org.apache.http.client.ClientProtocolException
java.net.URISyntaxException
java.io.IOException
CanorisException
public Pager getFiles() throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public CanorisFile getFile(CanorisFile file) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
file
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public CanorisFile getFile(java.lang.String fileKey) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
fileKey
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.io.InputStream downloadFile(CanorisFile file) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
file
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.io.InputStream downloadFile(java.lang.String fileKey) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
fileKey
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.io.InputStream getConversion(CanorisFile file, java.lang.String conversionName) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
file
- conversionName
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.util.Map<java.lang.String,java.lang.Object> getConversions(CanorisFile file) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
file
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public org.codehaus.jackson.JsonNode getAnalysis(CanorisFile file, java.lang.String filter) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
file
- filter
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public org.codehaus.jackson.JsonNode getAnalysisFrames(java.lang.String fileKey) throws org.codehaus.jackson.JsonParseException, org.codehaus.jackson.map.JsonMappingException, org.apache.http.ParseException, java.io.IOException, java.net.URISyntaxException, CanorisException
fileKey
-
org.codehaus.jackson.JsonParseException
org.codehaus.jackson.map.JsonMappingException
org.apache.http.ParseException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.io.InputStream getVisualization(CanorisFile file, java.lang.String name) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
file
- name
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.util.Map<java.lang.String,java.lang.Object> getVisualizations(CanorisFile file) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
file
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public org.codehaus.jackson.JsonNode getTemplates() throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public org.codehaus.jackson.JsonNode createTemplate(java.lang.String templateName, java.lang.String templateContent) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
templateName
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public org.codehaus.jackson.JsonNode updateTemplate(java.lang.String templateContent, java.lang.String templateName) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
templateContent
- templateName
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public void deleteTemplate(java.lang.String templateName) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
templateName
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.util.Map<java.lang.String,java.lang.Object> createTask(java.lang.String taskName, java.lang.String taskContent) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
taskName
- taskContent
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.util.Map<java.lang.String,java.lang.Object> getTask(java.lang.String taskId) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
taskId
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.util.Map<java.lang.String,java.lang.Object> getText2Phon(java.lang.String text, java.lang.String language) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
text
- language
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public Pager getCollections() throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
CanorisException
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
public java.util.Map<java.lang.String,java.lang.Object> getCollection(java.lang.String collectionKey) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
collectionKey
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.util.Map<java.lang.String,java.lang.Object> createCollection(java.lang.String name, java.lang.String license, java.lang.String visibility) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
name
- license
- visibility
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public void deleteCollection(java.lang.String collectionKey) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
collectionKey
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public Pager getCollectionFiles(java.lang.String collectionKey) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
collectionKey
- The key used to retrieve the collection.
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public void addFileToCollection(java.lang.String collectionKey, CanorisFile file) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
collectionKey
- file
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.util.Map<java.lang.String,java.lang.Object> getCollectionFile(java.lang.String collectionKey, CanorisFile file) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
collectionKey
- file
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public java.util.Map<java.lang.String,java.lang.Object> getSimilaritySearch(java.lang.String collectionKey, CanorisFile file, java.lang.String preset, java.lang.String results) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
collectionKey
- file
- preset
- results
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public Pager getPage(Pager pager) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public Pager getPage(java.lang.String start, java.lang.String limit) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public Pager getNextPage(Pager pager) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public Pager getPreviousPage(Pager pager) throws org.apache.http.client.ClientProtocolException, java.io.IOException, java.net.URISyntaxException, CanorisException
pager
-
org.apache.http.client.ClientProtocolException
java.io.IOException
java.net.URISyntaxException
CanorisException
public void useProxy(boolean useProxy)
useProxy
- public void configProxy(java.lang.String host, int port, java.lang.String protocol)
host
- port
- protocol
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |