org.deegree.protocol.wps.client.input
Class XMLInput

java.lang.Object
  org.deegree.protocol.wps.client.input.ExecutionInput
      org.deegree.protocol.wps.client.input.XMLInput

public class XMLInput
extends ExecutionInput

ExecutionInput that encapsulates an XML value.

Version:

$Revision: 26137 $, $Date: 2010-08-25 18:05:25 +0200 (Mi, 25. Aug 2010) $

Author:

Andrei Ionita, Markus Schneider, last edited by: $Author: aionita $

Constructor Summary

XMLInput(CodeType id, java.net.URL url, boolean isWebAccessible, java.lang.String mimeType, java.lang.String encoding, java.lang.String schema)
Creates a new XMLInput instance.

XMLInput(CodeType id, javax.xml.stream.XMLStreamReader reader, java.lang.String mimeType, java.lang.String encoding, java.lang.String schema)
Creates a new XMLInput instance.

Method Summary

javax.xml.stream.XMLStreamReader	getAsXMLStream() Returns the XML value as an XMLStreamReader.
ComplexFormat	getFormat() Returns the format of the input.
java.net.URL	getWebAccessibleURL() Returns the web-accessible URL for retrieving the input value.

Methods inherited from class org.deegree.protocol.wps.client.input.ExecutionInput

getId

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLInput

public XMLInput(CodeType id,
                java.net.URL url,
                boolean isWebAccessible,
                java.lang.String mimeType,
                java.lang.String encoding,
                java.lang.String schema)

Creates a new XMLInput instance.

Parameters:

id - parameter identifier, must not be null

url - URL for accessing the XML resource, must not be null

isWebAccessible - if true, the data will be submitted to the process as reference, otherwise it will be encoded in the request

mimeType - mime type of the XML resource, may be null (unspecified)

encoding - encoding, may be null (unspecified)

schema - XML schema, may be null (unspecified)

XMLInput

public XMLInput(CodeType id,
                javax.xml.stream.XMLStreamReader reader,
                java.lang.String mimeType,
                java.lang.String encoding,
                java.lang.String schema)

Creates a new XMLInput instance.

Parameters:

id - parameter identifier, must not be null

reader - xml stream that provides the data, must not be null and point to a START_ELEMENT event

mimeType - mime type of the XML resource, may be null (unspecified)

encoding - encoding, may be null (unspecified)

schema - XML schema, may be null (unspecified)

Method Detail

getFormat

public ComplexFormat getFormat()

Returns the format of the input.

Returns:

the format of the input, never null

getAsXMLStream

public javax.xml.stream.XMLStreamReader getAsXMLStream()
                                                throws javax.xml.stream.XMLStreamException,
                                                       java.io.IOException

Returns the XML value as an XMLStreamReader.

Returns:

an xml stream, current event is START_ELEMENT

Throws:

java.io.IOException - if accessing the value fails

javax.xml.stream.XMLStreamException

getWebAccessibleURL

public java.net.URL getWebAccessibleURL()

Description copied from class: ExecutionInput

Returns the web-accessible URL for retrieving the input value.

Overrides:

getWebAccessibleURL in class ExecutionInput

Returns:

web-accessible URL, can be null (not web-acessible)