Package net.opengis.wps20

Interface DocumentRoot

All Superinterfaces:

EObject, Notifier

All Known Implementing Classes:

DocumentRootImpl

public interface DocumentRoot
extends EObject

A representation of the model object 'Document Root'.

The following features are supported:

• Mixed
• XMLNS Prefix Map
• XSI Schema Location
• Bounding Box Data
• Data Description
• Capabilities
• Complex Data
• Contents
• Data
• Describe Process
• Dismiss
• Execute
• Expiration Date
• Format
• Generic Process
• Get Capabilities
• Get Result
• Get Status
• Job ID
• Literal Data
• Literal Value
• Process
• Process Offering
• Process Offerings
• Reference
• Result
• Status Info
• Supported CRS

See Also:

• Wps20Package.getDocumentRoot()

Method Summary

Modifier and Type	Method	Description
BoundingBoxDataType	getBoundingBoxData()	Returns the value of the 'Bounding Box Data' containment reference.
WPSCapabilitiesType	getCapabilities()	Returns the value of the 'Capabilities' containment reference.
ComplexDataType	getComplexData()	Returns the value of the 'Complex Data' containment reference.
ContentsType	getContents()	Returns the value of the 'Contents' containment reference.
DataType	getData()	Returns the value of the 'Data' containment reference.
DataDescriptionType	getDataDescription()	Returns the value of the 'Data Description' containment reference.
DescribeProcessType	getDescribeProcess()	Returns the value of the 'Describe Process' containment reference.
DismissType	getDismiss()	Returns the value of the 'Dismiss' containment reference.
ExecuteRequestType	getExecute()	Returns the value of the 'Execute' containment reference.
XMLGregorianCalendar	getExpirationDate()	Returns the value of the 'Expiration Date' attribute.
FormatType	getFormat()	Returns the value of the 'Format' containment reference.
GenericProcessType	getGenericProcess()	Returns the value of the 'Generic Process' containment reference.
GetCapabilitiesType	getGetCapabilities()	Returns the value of the 'Get Capabilities' containment reference.
GetResultType	getGetResult()	Returns the value of the 'Get Result' containment reference.
GetStatusType	getGetStatus()	Returns the value of the 'Get Status' containment reference.
String	getJobID()	Returns the value of the 'Job ID' attribute.
LiteralDataType	getLiteralData()	Returns the value of the 'Literal Data' containment reference.
LiteralValueType	getLiteralValue()	Returns the value of the 'Literal Value' containment reference.
FeatureMap	getMixed()	Returns the value of the 'Mixed' attribute list.
ProcessDescriptionType	getProcess()	Returns the value of the 'Process' containment reference.
ProcessOfferingType	getProcessOffering()	Returns the value of the 'Process Offering' containment reference.
ProcessOfferingsType	getProcessOfferings()	Returns the value of the 'Process Offerings' containment reference.
ReferenceType	getReference()	Returns the value of the 'Reference' containment reference.
ResultType	getResult()	Returns the value of the 'Result' containment reference.
StatusInfoType	getStatusInfo()	Returns the value of the 'Status Info' containment reference.
SupportedCRSType	getSupportedCRS()	Returns the value of the 'Supported CRS' containment reference.
EMap<String,String>	getXMLNSPrefixMap()	Returns the value of the 'XMLNS Prefix Map' map.
EMap<String,String>	getXSISchemaLocation()	Returns the value of the 'XSI Schema Location' map.
void	setBoundingBoxData(BoundingBoxDataType value)	Sets the value of the 'Bounding Box Data' containment reference.
void	setCapabilities(WPSCapabilitiesType value)	Sets the value of the 'Capabilities' containment reference.
void	setComplexData(ComplexDataType value)	Sets the value of the 'Complex Data' containment reference.
void	setContents(ContentsType value)	Sets the value of the 'Contents' containment reference.
void	setData(DataType value)	Sets the value of the 'Data' containment reference.
void	setDescribeProcess(DescribeProcessType value)	Sets the value of the 'Describe Process' containment reference.
void	setDismiss(DismissType value)	Sets the value of the 'Dismiss' containment reference.
void	setExecute(ExecuteRequestType value)	Sets the value of the 'Execute' containment reference.
void	setExpirationDate(XMLGregorianCalendar value)	Sets the value of the 'Expiration Date' attribute.
void	setFormat(FormatType value)	Sets the value of the 'Format' containment reference.
void	setGenericProcess(GenericProcessType value)	Sets the value of the 'Generic Process' containment reference.
void	setGetCapabilities(GetCapabilitiesType value)	Sets the value of the 'Get Capabilities' containment reference.
void	setGetResult(GetResultType value)	Sets the value of the 'Get Result' containment reference.
void	setGetStatus(GetStatusType value)	Sets the value of the 'Get Status' containment reference.
void	setJobID(String value)	Sets the value of the 'Job ID' attribute.
void	setLiteralData(LiteralDataType value)	Sets the value of the 'Literal Data' containment reference.
void	setLiteralValue(LiteralValueType value)	Sets the value of the 'Literal Value' containment reference.
void	setProcess(ProcessDescriptionType value)	Sets the value of the 'Process' containment reference.
void	setProcessOffering(ProcessOfferingType value)	Sets the value of the 'Process Offering' containment reference.
void	setProcessOfferings(ProcessOfferingsType value)	Sets the value of the 'Process Offerings' containment reference.
void	setReference(ReferenceType value)	Sets the value of the 'Reference' containment reference.
void	setResult(ResultType value)	Sets the value of the 'Result' containment reference.
void	setStatusInfo(StatusInfoType value)	Sets the value of the 'Status Info' containment reference.
void	setSupportedCRS(SupportedCRSType value)	Sets the value of the 'Supported CRS' containment reference.

Methods inherited from interface EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Details

getMixed

FeatureMap getMixed()

Returns the value of the 'Mixed' attribute list. The list contents are of type FeatureMap.Entry.

Returns:

the value of the 'Mixed' attribute list.

See Also:

• Wps20Package.getDocumentRoot_Mixed()

getXMLNSPrefixMap

EMap<String,String> getXMLNSPrefixMap()

Returns the value of the 'XMLNS Prefix Map' map. The key is of type String, and the value is of type String,

Returns:

the value of the 'XMLNS Prefix Map' map.

See Also:

• Wps20Package.getDocumentRoot_XMLNSPrefixMap()

getXSISchemaLocation

EMap<String,String> getXSISchemaLocation()

Returns the value of the 'XSI Schema Location' map. The key is of type String, and the value is of type String,

Returns:

the value of the 'XSI Schema Location' map.

See Also:

• Wps20Package.getDocumentRoot_XSISchemaLocation()

getBoundingBoxData

BoundingBoxDataType getBoundingBoxData()

Returns the value of the 'Bounding Box Data' containment reference. Indicates that this Input shall be a BoundingBox data structure that is embedded in the execute request, and provides a list of the Coordinate Reference System support for this Bounding Box.

Returns:

the value of the 'Bounding Box Data' containment reference.

See Also:

• setBoundingBoxData(BoundingBoxDataType)
• Wps20Package.getDocumentRoot_BoundingBoxData()

setBoundingBoxData

void setBoundingBoxData(BoundingBoxDataType value)

Sets the value of the 'Bounding Box Data' containment reference.

Parameters:

value - the new value of the 'Bounding Box Data' containment reference.

See Also:

• getBoundingBoxData()

getDataDescription

DataDescriptionType getDataDescription()

Returns the value of the 'Data Description' containment reference.

Returns:

the value of the 'Data Description' containment reference.

See Also:

• Wps20Package.getDocumentRoot_DataDescription()

getCapabilities

WPSCapabilitiesType getCapabilities()

Returns the value of the 'Capabilities' containment reference. WPS GetCapabilities operation response. This document provides clients with service metadata about a specific service instance, including metadata about the processes that can be executed. Since the server does not implement the updateSequence and Sections parameters, the server shall always return the complete Capabilities document, without the updateSequence parameter.

Returns:

the value of the 'Capabilities' containment reference.

See Also:

• setCapabilities(WPSCapabilitiesType)
• Wps20Package.getDocumentRoot_Capabilities()

setCapabilities

void setCapabilities(WPSCapabilitiesType value)

Sets the value of the 'Capabilities' containment reference.

Parameters:

value - the new value of the 'Capabilities' containment reference.

See Also:

• getCapabilities()

getComplexData

ComplexDataType getComplexData()

Returns the value of the 'Complex Data' containment reference. Indicates that this input/output shall be a complex data structure (such as a GML document or a GeoTiff image that comply with a particular format definition).

Returns:

the value of the 'Complex Data' containment reference.

See Also:

• setComplexData(ComplexDataType)
• Wps20Package.getDocumentRoot_ComplexData()

setComplexData

void setComplexData(ComplexDataType value)

Sets the value of the 'Complex Data' containment reference.

Parameters:

value - the new value of the 'Complex Data' containment reference.

See Also:

• getComplexData()

getContents

ContentsType getContents()

Returns the value of the 'Contents' containment reference. List of brief descriptions of the processes offered by this WPS server.

Returns:

the value of the 'Contents' containment reference.

See Also:

• setContents(ContentsType)
• Wps20Package.getDocumentRoot_Contents()

setContents

void setContents(ContentsType value)

Sets the value of the 'Contents' containment reference.

Parameters:

value - the new value of the 'Contents' containment reference.

See Also:

• getContents()

getData

DataType getData()

Returns the value of the 'Data' containment reference.

Returns:

the value of the 'Data' containment reference.

See Also:

• setData(DataType)
• Wps20Package.getDocumentRoot_Data()

setData

void setData(DataType value)

Sets the value of the 'Data' containment reference.

Parameters:

value - the new value of the 'Data' containment reference.

See Also:

• getData()

getDescribeProcess

DescribeProcessType getDescribeProcess()

Returns the value of the 'Describe Process' containment reference. WPS DescribeProcess operation request.

Returns:

the value of the 'Describe Process' containment reference.

See Also:

• setDescribeProcess(DescribeProcessType)
• Wps20Package.getDocumentRoot_DescribeProcess()

setDescribeProcess

void setDescribeProcess(DescribeProcessType value)

Sets the value of the 'Describe Process' containment reference.

Parameters:

value - the new value of the 'Describe Process' containment reference.

See Also:

• getDescribeProcess()

getDismiss

DismissType getDismiss()

Returns the value of the 'Dismiss' containment reference. WPS GetStatus operation request. This operation is used to query status information of executed processes. The response to a GetStatus operation is a StatusInfo document or an exception. Depending on the implementation, a WPS may "forget" old process executions sooner or later. In this case, there is no status information available and an exception shall be returned instead of a StatusInfo response.

Returns:

the value of the 'Dismiss' containment reference.

See Also:

• setDismiss(DismissType)
• Wps20Package.getDocumentRoot_Dismiss()

setDismiss

void setDismiss(DismissType value)

Sets the value of the 'Dismiss' containment reference.

Parameters:

value - the new value of the 'Dismiss' containment reference.

See Also:

• getDismiss()

getExecute

ExecuteRequestType getExecute()

Returns the value of the 'Execute' containment reference.

Returns:

the value of the 'Execute' containment reference.

See Also:

• setExecute(ExecuteRequestType)
• Wps20Package.getDocumentRoot_Execute()

setExecute

void setExecute(ExecuteRequestType value)

Sets the value of the 'Execute' containment reference.

Parameters:

value - the new value of the 'Execute' containment reference.

See Also:

• getExecute()

getExpirationDate

XMLGregorianCalendar getExpirationDate()

Returns the value of the 'Expiration Date' attribute. Date and time by which the job and its results will be removed from the server. Use if appropriate. In some situations the expiration date may not be known from the start. In this case, it is recommended to specify a timestamp for NextPoll. A typical example is a long running process for which the results are stored 48 hours after completion. While the process is running, clients are provided with updated timestamps for NextPoll. As soon as the process has completed the ExpirationDate is determined.

Returns:

the value of the 'Expiration Date' attribute.

See Also:

• setExpirationDate(XMLGregorianCalendar)
• Wps20Package.getDocumentRoot_ExpirationDate()

setExpirationDate

void setExpirationDate(XMLGregorianCalendar value)

Sets the value of the 'Expiration Date' attribute.

Parameters:

value - the new value of the 'Expiration Date' attribute.

See Also:

• getExpirationDate()

getFormat

FormatType getFormat()

Returns the value of the 'Format' containment reference.

Returns:

the value of the 'Format' containment reference.

See Also:

• setFormat(FormatType)
• Wps20Package.getDocumentRoot_Format()

setFormat

void setFormat(FormatType value)

Sets the value of the 'Format' containment reference.

Parameters:

value - the new value of the 'Format' containment reference.

See Also:

• getFormat()

getGenericProcess

GenericProcessType getGenericProcess()

Returns the value of the 'Generic Process' containment reference.

Returns:

the value of the 'Generic Process' containment reference.

See Also:

• setGenericProcess(GenericProcessType)
• Wps20Package.getDocumentRoot_GenericProcess()

setGenericProcess

void setGenericProcess(GenericProcessType value)

Sets the value of the 'Generic Process' containment reference.

Parameters:

value - the new value of the 'Generic Process' containment reference.

See Also:

• getGenericProcess()

getGetCapabilities

GetCapabilitiesType getGetCapabilities()

Returns the value of the 'Get Capabilities' containment reference. Request to a WPS server to perform the GetCapabilities operation. This operation allows a client to retrieve a Capabilities XML document providing metadata for the specific WPS server.

Returns:

the value of the 'Get Capabilities' containment reference.

See Also:

• setGetCapabilities(GetCapabilitiesType)
• Wps20Package.getDocumentRoot_GetCapabilities()

setGetCapabilities

void setGetCapabilities(GetCapabilitiesType value)

Sets the value of the 'Get Capabilities' containment reference.

Parameters:

value - the new value of the 'Get Capabilities' containment reference.

See Also:

• getGetCapabilities()

getGetResult

GetResultType getGetResult()

Returns the value of the 'Get Result' containment reference. WPS GetResult operation request. This operation is used to query the results of asynchrously executed processes. The response to a GetResult operation is a wps:ProcessingResult, a raw data response, or an exception. Depending on the implementation, a WPS may "forget" old process executions sooner or later. In this case, there is no result information available and an exception shall be returned.

Returns:

the value of the 'Get Result' containment reference.

See Also:

• setGetResult(GetResultType)
• Wps20Package.getDocumentRoot_GetResult()

setGetResult

void setGetResult(GetResultType value)

Sets the value of the 'Get Result' containment reference.

Parameters:

value - the new value of the 'Get Result' containment reference.

See Also:

• getGetResult()

getGetStatus

GetStatusType getGetStatus()

Returns the value of the 'Get Status' containment reference. WPS GetStatus operation request. This operation is used to query status information of executed processes. The response to a GetStatus operation is a StatusInfo document or an exception. Depending on the implementation, a WPS may "forget" old process executions sooner or later. In this case, there is no status information available and an exception shall be returned instead of a StatusInfo response.

Returns:

the value of the 'Get Status' containment reference.

See Also:

• setGetStatus(GetStatusType)
• Wps20Package.getDocumentRoot_GetStatus()

setGetStatus

void setGetStatus(GetStatusType value)

Sets the value of the 'Get Status' containment reference.

Parameters:

value - the new value of the 'Get Status' containment reference.

See Also:

• getGetStatus()

getJobID

String getJobID()

Returns the value of the 'Job ID' attribute. A JobID is a unique identifier for a process execution, i.e. a process instance. Particularly suitable JobIDs are UUIDs or monotonic identifiers such as unique timestamps. If the privacy of a Processing Job is imperative, the JobID should be non-guessable.

Returns:

the value of the 'Job ID' attribute.

See Also:

• setJobID(String)
• Wps20Package.getDocumentRoot_JobID()

setJobID

void setJobID(String value)

Sets the value of the 'Job ID' attribute.

Parameters:

value - the new value of the 'Job ID' attribute.

See Also:

• getJobID()

getLiteralData

LiteralDataType getLiteralData()

Returns the value of the 'Literal Data' containment reference.

Returns:

the value of the 'Literal Data' containment reference.

See Also:

• setLiteralData(LiteralDataType)
• Wps20Package.getDocumentRoot_LiteralData()

setLiteralData

void setLiteralData(LiteralDataType value)

Sets the value of the 'Literal Data' containment reference.

Parameters:

value - the new value of the 'Literal Data' containment reference.

See Also:

• getLiteralData()

getLiteralValue

LiteralValueType getLiteralValue()

Returns the value of the 'Literal Value' containment reference.

Returns:

the value of the 'Literal Value' containment reference.

See Also:

• setLiteralValue(LiteralValueType)
• Wps20Package.getDocumentRoot_LiteralValue()

setLiteralValue

void setLiteralValue(LiteralValueType value)

Sets the value of the 'Literal Value' containment reference.

Parameters:

value - the new value of the 'Literal Value' containment reference.

See Also:

• getLiteralValue()

getProcess

ProcessDescriptionType getProcess()

Returns the value of the 'Process' containment reference. The description of a single process, including the input and output items.

Returns:

the value of the 'Process' containment reference.

See Also:

• setProcess(ProcessDescriptionType)
• Wps20Package.getDocumentRoot_Process()

setProcess

void setProcess(ProcessDescriptionType value)

Sets the value of the 'Process' containment reference.

Parameters:

value - the new value of the 'Process' containment reference.

See Also:

• getProcess()

getProcessOffering

ProcessOfferingType getProcessOffering()

Returns the value of the 'Process Offering' containment reference. A process offering is a process description. It has additional attributes that provide additional information on how this process can be executed on a particular service instance (execution modes, data transmission modes, informative process version.)

Returns:

the value of the 'Process Offering' containment reference.

See Also:

• setProcessOffering(ProcessOfferingType)
• Wps20Package.getDocumentRoot_ProcessOffering()

setProcessOffering

void setProcessOffering(ProcessOfferingType value)

Sets the value of the 'Process Offering' containment reference.

Parameters:

value - the new value of the 'Process Offering' containment reference.

See Also:

• getProcessOffering()

getProcessOfferings

ProcessOfferingsType getProcessOfferings()

Returns the value of the 'Process Offerings' containment reference. List structure that is returned by the WPS DescribeProcess operation. Contains XML descriptions for the queried process identifiers.

Returns:

the value of the 'Process Offerings' containment reference.

See Also:

• setProcessOfferings(ProcessOfferingsType)
• Wps20Package.getDocumentRoot_ProcessOfferings()

setProcessOfferings

void setProcessOfferings(ProcessOfferingsType value)

Sets the value of the 'Process Offerings' containment reference.

Parameters:

value - the new value of the 'Process Offerings' containment reference.

See Also:

• getProcessOfferings()

getReference

ReferenceType getReference()

Returns the value of the 'Reference' containment reference. This element is used for web accessible references to a data set or value.

Returns:

the value of the 'Reference' containment reference.

See Also:

• setReference(ReferenceType)
• Wps20Package.getDocumentRoot_Reference()

setReference

void setReference(ReferenceType value)

Sets the value of the 'Reference' containment reference.

Parameters:

value - the new value of the 'Reference' containment reference.

See Also:

• getReference()

getResult

ResultType getResult()

Returns the value of the 'Result' containment reference. A Result document is a structure that contains the results of a process execution. It is a shared element between the Execute and GetResult operations.

Returns:

the value of the 'Result' containment reference.

See Also:

• setResult(ResultType)
• Wps20Package.getDocumentRoot_Result()

setResult

void setResult(ResultType value)

Sets the value of the 'Result' containment reference.

Parameters:

value - the new value of the 'Result' containment reference.

See Also:

• getResult()

getStatusInfo

StatusInfoType getStatusInfo()

Returns the value of the 'Status Info' containment reference. StatusInfo document containing information about executed processes.

Returns:

the value of the 'Status Info' containment reference.

See Also:

• setStatusInfo(StatusInfoType)
• Wps20Package.getDocumentRoot_StatusInfo()

setStatusInfo

void setStatusInfo(StatusInfoType value)

Sets the value of the 'Status Info' containment reference.

Parameters:

value - the new value of the 'Status Info' containment reference.

See Also:

• getStatusInfo()

getSupportedCRS

SupportedCRSType getSupportedCRS()

Returns the value of the 'Supported CRS' containment reference. Supported CRS supported for this Input/Output. "default" shall be used on only one element. This default element identifies the default CRS.

Returns:

the value of the 'Supported CRS' containment reference.

See Also:

• setSupportedCRS(SupportedCRSType)
• Wps20Package.getDocumentRoot_SupportedCRS()

setSupportedCRS

void setSupportedCRS(SupportedCRSType value)

Sets the value of the 'Supported CRS' containment reference.

Parameters:

value - the new value of the 'Supported CRS' containment reference.

See Also:

• getSupportedCRS()