GSVirtualTable: Geoserver REST API GSVirtualTable

GSVirtualTableR Documentation

Geoserver REST API GSVirtualTable

Description

Geoserver REST API GSVirtualTable

Geoserver REST API GSVirtualTable

Format

R6Class object.

Value

Object of R6Class for modelling a GeoServer virtual table

Methods

new(xml)

This method is used to instantiate a GSVirtualTable

decode(xml)

This method is used to decode a GSVirtualTable from XML

encode()

This method is used to encode a GSVirtualTable to XML

setName(name)

Sets the name of the virtual table

setSql(sql)

Sets the sql of the virtual table

setEscapeSql(escapeSql)

Sets the escapeSql. Default is FALSE

setKeyColumn(keyColumn)

Sets the keyColumn. Name of the column to be the primary key

setGeometry(vtg)

Sets the virtual table geometry

addParameter(parameter)

Adds a virtual table parameter

delParameter(parameter)

Removes a virtual table parameter.

Super class

geosapi::GSRESTResource -> GSVirtualTable

Public fields

name

name

sql

SQL statement

escapeSql

escape SQL?

keyColumn

key column

geometry

geometry

parameters

list of virtual parameters

Methods

Public methods

Inherited methods

Method new()

Initializes an object of class GSVirtualTable

Usage
GSVirtualTable$new(xml = NULL)
Arguments
xml

object of class XMLInternalNode-class


Method decode()

Decodes from XML

Usage
GSVirtualTable$decode(xml)
Arguments
xml

object of class XMLInternalNode-class


Method setName()

Set name

Usage
GSVirtualTable$setName(name)
Arguments
name

name


Method setSql()

Set SQL

Usage
GSVirtualTable$setSql(sql)
Arguments
sql

sql


Method setEscapeSql()

Set escape SQL

Usage
GSVirtualTable$setEscapeSql(escapeSql)
Arguments
escapeSql

escape SQL


Method setKeyColumn()

Set key column

Usage
GSVirtualTable$setKeyColumn(keyColumn)
Arguments
keyColumn

key column


Method setGeometry()

Set geometry

Usage
GSVirtualTable$setGeometry(vtg)
Arguments
vtg

object of class GSVirtualTableGeometry


Method addParameter()

Adds parameter

Usage
GSVirtualTable$addParameter(parameter)
Arguments
parameter

object of class GSVirtualTableParameter

Returns

TRUE if added, FALSE otherwise


Method delParameter()

Deletes parameter

Usage
GSVirtualTable$delParameter(parameter)
Arguments
parameter

object of class GSVirtualTableParameter

Returns

TRUE if deleted, FALSE otherwise


Method clone()

The objects of this class are cloneable with this method.

Usage
GSVirtualTable$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Emmanuel Blondel <emmanuel.blondel1@gmail.com>

Examples

GSVirtualTable$new()


geosapi documentation built on May 2, 2022, 5:05 p.m.