Interface ToolContext
-
public interface ToolContext
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidexecutePipeline()DocumentgetInputDocument()Request a document based on the standard input stream.DocumentgetInputDocument(String id)Request a document based on the input stream.InputStreamgetInputStream()Request the standard input stream.InputStreamgetInputStream(String id)Request an input stream.OutputStreamgetOutputStream()OutputStreamgetOutputStream(String id)StringgetParameter(String name)String[]getParameters(String name)ObjectgetUserObject(String key)booleanhasParameter(String name)voidsendDocument(String id, Document doc)voidsendDocument(Document doc)voidsetUserObject(String key, Object o)
-
-
-
Method Detail
-
getInputStream
InputStream getInputStream(String id) throws ToolException
Request an input stream.- Parameters:
id- the id of the stream in the streams sections of the tool's definition document.- Throws:
ToolException
-
getInputStream
InputStream getInputStream() throws ToolException
Request the standard input stream.- Throws:
ToolException
-
getInputDocument
Document getInputDocument(String id) throws ToolException
Request a document based on the input stream. This is only returned if the mime type of incoming stream is xml.- Throws:
ToolException
-
getInputDocument
Document getInputDocument() throws ToolException
Request a document based on the standard input stream. This is only returned if the mime type of incoming stream is xml.- Throws:
ToolException
-
getOutputStream
OutputStream getOutputStream(String id) throws ToolException
- Throws:
ToolException
-
getOutputStream
OutputStream getOutputStream() throws ToolException
- Throws:
ToolException
-
getParameter
String getParameter(String name) throws ToolException
- Throws:
ToolException
-
getParameters
String[] getParameters(String name) throws ToolException
- Throws:
ToolException
-
hasParameter
boolean hasParameter(String name) throws ToolException
- Throws:
ToolException
-
sendDocument
void sendDocument(Document doc)
-
executePipeline
void executePipeline()
-
-