Serialized Form (SHOGun2 Core 0.1.0 API)

Package de.terrestris.shogun2.model
- Class de.terrestris.shogun2.model.Application extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      The name of the application.
    - description
```
String description
```
      The description of the application
    - language
```
Locale language
```
      The language of the application.
    - open
```
Boolean open
```
      Whether this application is open, meaning it is accessible to the general non-authenticated public.
    - active
```
Boolean active
```
      Whether this application is currently accessible at all. Applications can be disabled/enabled by setting this flag.
    - url
```
String url
```
      The URL under which the application is accessible.
    - viewport
```
CompositeModule viewport
```
- Class de.terrestris.shogun2.model.File extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - active
```
Boolean active
```
    - fileName
```
String fileName
```
    - fileType
```
String fileType
```
    - file
```
byte[] file
```
- Class de.terrestris.shogun2.model.ImageFile extends File implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - thumbnail
```
byte[] thumbnail
```
    - width
```
Integer width
```
    - height
```
Integer height
```
- Class de.terrestris.shogun2.model.PersistentObject extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
Integer id
```
    - created
```
org.joda.time.ReadableDateTime created
```
      The getter of this property PersistentObject.getCreated() is annotated with JsonIgnore. This way, the annotation can be overwritten in subclasses.
    - modified
```
org.joda.time.ReadableDateTime modified
```
      The getter of this property PersistentObject.getModified() is annotated with JsonIgnore. This way, the annotation can be overwritten in subclasses.
    - userPermissions
```
Map<K,V> userPermissions
```
    - groupPermissions
```
Map<K,V> groupPermissions
```
- Class de.terrestris.shogun2.model.Person extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - firstName
```
String firstName
```
    - lastName
```
String lastName
```
    - email
```
String email
```
    - birthday
```
org.joda.time.LocalDate birthday
```
    - language
```
Locale language
```
- Class de.terrestris.shogun2.model.Role extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
    - description
```
String description
```
- Class de.terrestris.shogun2.model.Territory extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
    - geometry
```
com.vividsolutions.jts.geom.MultiPolygon geometry
```
- Class de.terrestris.shogun2.model.User extends Person implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - accountName
```
String accountName
```
    - password
```
String password
```
    - active
```
boolean active
```
    - roles
```
Set<E> roles
```
    - userGroups
```
Set<E> userGroups
```
- Class de.terrestris.shogun2.model.UserGroup extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
    - owner
```
User owner
```
    - members
```
Set<E> members
```
    - roles
```
Set<E> roles
```
Package de.terrestris.shogun2.model.interceptor
- Class de.terrestris.shogun2.model.interceptor.InterceptorRule extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - event
```
HttpEnum.EventType event
```
      The event for this rule, possible values are: * REQUEST * RESPONSE
    - rule
```
InterceptorEnum.RuleType rule
```
      The rule type for this rule, possible rules are: * ALLOW * DENY * MODIFY
    - service
```
OgcEnum.ServiceType service
```
      The OGC service type, possible rules are: * WMS * WFS * WCS
    - operation
```
OgcEnum.OperationType operation
```
      The OGC operation type, e.g. GetMap.
    - endPoint
```
String endPoint
```
      The OGC/GeoServer endPoint (a generalization for layer, featureType, coverage or namespace), e.g. SHOGUN:SHINJI.
Package de.terrestris.shogun2.model.layer
- Class de.terrestris.shogun2.model.layer.Layer extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
    - source
```
LayerDataSource source
```
    - appearance
```
LayerAppearance appearance
```
Package de.terrestris.shogun2.model.layer.appearance
- Class de.terrestris.shogun2.model.layer.appearance.LayerAppearance extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - attribution
```
String attribution
```
    - name
```
String name
```
    - maxResolution
```
Double maxResolution
```
    - minResolution
```
Double minResolution
```
    - opacity
```
Double opacity
```
    - visible
```
Boolean visible
```
Package de.terrestris.shogun2.model.layer.source
- Class de.terrestris.shogun2.model.layer.source.ImageWmsLayerDataSource extends LayerDataSource implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - width
```
int width
```
    - height
```
int height
```
    - version
```
String version
```
    - layerNames
```
String layerNames
```
    - layerStyles
```
String layerStyles
```
- Class de.terrestris.shogun2.model.layer.source.LayerDataSource extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
    - type
```
String type
```
    - url
```
String url
```
- Class de.terrestris.shogun2.model.layer.source.TileWmsLayerDataSource extends ImageWmsLayerDataSource implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - tileGrid
```
TileGrid tileGrid
```
- Class de.terrestris.shogun2.model.layer.source.VectorLayerDataSource extends LayerDataSource implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - format
```
String format
```
- Class de.terrestris.shogun2.model.layer.source.WmtsLayerDataSource extends LayerDataSource implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.terrestris.shogun2.model.layer.source.XyzLayerDataSource extends LayerDataSource implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - center
```
Point2D.Double center
```
    - extent
```
Extent extent
```
    - resolutions
```
List<E> resolutions
```
    - tileSize
```
Integer tileSize
```
Package de.terrestris.shogun2.model.layer.util
- Class de.terrestris.shogun2.model.layer.util.Extent extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - lowerLeft
```
Point2D.Double lowerLeft
```
    - upperRight
```
Point2D.Double upperRight
```
- Class de.terrestris.shogun2.model.layer.util.TileGrid extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - type
```
String type
```
      The tileGrid type. Typically one of `TileGrid` or `WMTS`.
    - tileGridOrigin
```
Point2D.Double tileGridOrigin
```
      The tile grid origin, i.e. where the x and y axes meet ([z, 0, 0]). Tile coordinates increase left to right and upwards. If not specified, extent or origins must be provided.
    - tileGridExtent
```
Extent tileGridExtent
```
      Extent for the tile grid. No tiles outside this extent will be requested by ol.source.Tile sources. When no origin or origins are configured, the origin will be set to the top-left corner of the extent.
    - tileSize
```
Integer tileSize
```
      default value: 256
    - tileGridResolutions
```
List<E> tileGridResolutions
```
      The tileGrid resolutions.
Package de.terrestris.shogun2.model.layout
- Class de.terrestris.shogun2.model.layout.AbsoluteLayout extends Layout implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - coords
```
List<E> coords
```
- Class de.terrestris.shogun2.model.layout.BorderLayout extends Layout implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - regions
```
List<E> regions
```
- Class de.terrestris.shogun2.model.layout.Layout extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - type
```
String type
```
      The type of the layout, e.g. "border", "absolute", "hbox" or "vbox".
    - propertyHints
```
Set<E> propertyHints
```
      A set of property names that are recommended for the use in the related child modules. CompositeModule.getSubModules().
    - propertyMusts
```
Set<E> propertyMusts
```
      A set of property names that are required for the use in the related child modules. CompositeModule.getSubModules().
Package de.terrestris.shogun2.model.map
- Class de.terrestris.shogun2.model.map.MapConfig extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
    - center
```
Point2D.Double center
```
    - extent
```
Extent extent
```
    - resolutions
```
List<E> resolutions
```
    - zoom
```
Integer zoom
```
    - maxResolution
```
Double maxResolution
```
    - minResolution
```
Double minResolution
```
    - rotation
```
Double rotation
```
    - projection
```
String projection
```
- Class de.terrestris.shogun2.model.map.MapControl extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - mapControlName
```
String mapControlName
```
      String which represents the OL3 class name of the interaction, e.g.
      
      ol.control.Zoom
      
      ol.control.Rotate
      
      ol.control.Attribution
      
      ...
    - mapControlProperties
```
Map<K,V> mapControlProperties
```
Package de.terrestris.shogun2.model.module
- Class de.terrestris.shogun2.model.module.AccordionPanel extends CompositeModule implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - expandedItem
```
Module expandedItem
```
      Defines which of the contained Modules is initially expanded.
- Class de.terrestris.shogun2.model.module.Button extends Module implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - text
```
String text
```
      A text to display on the button.
    - tooltip
```
String tooltip
```
      The text showing up when hovering the button.
    - glyph
```
String glyph
```
      A glyph String to display an iconFont sign. e.g. 'xf059@FontAwesome'
    - connectedModule
```
Module connectedModule
```
      The module which is connected to the button, if action OPENMODULEWINDOW set.
    - interaction
```
String interaction
```
      If action TOGGLEINTERACTION is set: This string represents the ol3 interaction class. e.g. 'ol.interaction.DragZoom'
    - buttonAction
```
String buttonAction
```
      The buttonAction describes the action/handler of the button. The String can be any of the ButtonClasses available in the BasiGX Package (https://github.com/terrestris/BasiGX). e.g. "ToggleLegend" Use "Measurearea" or "Measureline" to specify the type of the BasiGX.view.button.Measure. Additional there are two ActionTypes to be more flexible: OPENMODULEWINDOW (this.connectedModule required) Opens any module in an Ext.window.Window. TOGGLEINTERACTION (this.interaction required) Toggles the functionality of an OpenLayers 3 interaction.
- Class de.terrestris.shogun2.model.module.CompositeModule extends Module implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - layout
```
Layout layout
```
      The Layout of this CompositeModule, that contains property hints/musts for the child modules of this CompositeModule.
    - subModules
```
List<E> subModules
```
- Class de.terrestris.shogun2.model.module.CoordinateTransformation extends Module implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - epsgCodes
```
List<E> epsgCodes
```
      A list of EPSG-Codes that should be available in the module.
    - transformCenterOnRender
```
Boolean transformCenterOnRender
```
      Whether the form should be filled on instantiation or not.
- Class de.terrestris.shogun2.model.module.Image extends Module implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - src
```
String src
```
      The path to the image;
    - link
```
String link
```
      An optional link, if the image is clickable.
    - altText
```
String altText
```
      The alternative Text for the Image.
- Class de.terrestris.shogun2.model.module.Map extends Module implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - mapConfig
```
MapConfig mapConfig
```
      The MapConfig used by this Map. A MapConfig can be used by several maps or overview maps.
    - mapControls
```
Set<E> mapControls
```
      The controls used within this Map.
    - mapLayers
```
List<E> mapLayers
```
      The layers used within this Map.
- Class de.terrestris.shogun2.model.module.Module extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
    - xtype
```
String xtype
```
      The class name (e.g. the xtype in ExtJS) of this module.
    - properties
```
Map<K,V> properties
```
- Class de.terrestris.shogun2.model.module.NominatimSearch extends Module implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - format
```
NominatimSearch.NominatimFormatType format
```
      The response format.
    - resultLimit
```
Integer resultLimit
```
      Limits the response.
    - viewboxlbrt
```
List<E> viewboxlbrt
```
      A list of EPSG-Codes the should be available in the module.
    - minSearchTextChars
```
Integer minSearchTextChars
```
      Characters needed to send a request.
    - typeDelay
```
Integer typeDelay
```
      The delay between hitting a key and sending the request in ms.
    - groupHeaderTpl
```
String groupHeaderTpl
```
      The template of the grouping Header. See: http://docs.sencha.com/extjs/6.0/6.0.0-classic/#!/api/Ext.grid.feature.Grouping-cfg-groupHeaderTpl
- Class de.terrestris.shogun2.model.module.OverpassSearch extends Module implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - format
```
OverpassSearch.OverpassFormatType format
```
      The response format.
    - resultLimit
```
Integer resultLimit
```
      Limits the response.
    - viewboxlbrt
```
List<E> viewboxlbrt
```
      A list of EPSG-Codes the should be available in the module.
    - minSearchTextChars
```
Integer minSearchTextChars
```
      Characters needed to send a request.
    - typeDelay
```
Integer typeDelay
```
      The delay between hitting a key and sending the request in ms.
    - groupHeaderTpl
```
String groupHeaderTpl
```
      The template of the grouping Header. See: http://docs.sencha.com/extjs/6.0/6.0.0-classic/#!/api/Ext.grid.feature.Grouping-cfg-groupHeaderTpl
- Class de.terrestris.shogun2.model.module.OverviewMap extends Module implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - magnification
```
Integer magnification
```
    - overviewMapLayers
```
List<E> overviewMapLayers
```
      The layers used within this OverviewMap.
    - parentMapModule
```
Map parentMapModule
```
- Class de.terrestris.shogun2.model.module.Print extends Module implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - url
```
String url
```
      The mapfish-print url.
- Class de.terrestris.shogun2.model.module.WfsSearch extends Module implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - wfsServerUrl
```
String wfsServerUrl
```
      The WFS server URL
    - minSearchTextChars
```
Integer minSearchTextChars
```
      Characters needed to send a request.
    - typeDelay
```
Integer typeDelay
```
      The delay between hitting a key and sending the request in ms.
    - groupHeaderTpl
```
String groupHeaderTpl
```
      The template of the grouping Header. See: http://docs.sencha.com/extjs/6.0/6.0.0-classic/#!/api/Ext.grid.feature.Grouping-cfg-groupHeaderTpl
    - layers
```
List<E> layers
```
      The layers to search in.
    - allowedFeatureTypeDataTypes
```
List<E> allowedFeatureTypeDataTypes
```
      The allowed data-types to match against in the describefeaturetype response
Package de.terrestris.shogun2.model.security
- Class de.terrestris.shogun2.model.security.PermissionCollection extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - permissions
```
Set<E> permissions
```
Package de.terrestris.shogun2.model.token
- Class de.terrestris.shogun2.model.token.PasswordResetToken extends UserToken implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.terrestris.shogun2.model.token.RegistrationToken extends UserToken implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.terrestris.shogun2.model.token.Token extends PersistentObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - token
```
String token
```
      The (unique) token string itself.
    - expirationDate
```
org.joda.time.ReadableDateTime expirationDate
```
      The expiration date of the token. Will be set
- Class de.terrestris.shogun2.model.token.UserToken extends Token implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - user
```
User user
```
      The user who has requested the token. Hereby one user can have one token and one token can be used by one user (at the same time) only.
Package de.terrestris.shogun2.util.interceptor
- Class de.terrestris.shogun2.util.interceptor.InterceptorException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
Package de.terrestris.shogun2.util.json
- Class de.terrestris.shogun2.util.json.Shogun2JsonObjectMapper extends com.fasterxml.jackson.databind.ObjectMapper implements Serializable
  
  serialVersionUID:
  
  1L
Package de.terrestris.shogun2.util.naming
- Class de.terrestris.shogun2.util.naming.ImplicitNamingStrategyShogun2 extends org.hibernate.boot.model.naming.ImplicitNamingStrategyJpaCompliantImpl implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.terrestris.shogun2.util.naming.PhysicalNamingStrategyShogun2 extends org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - tablePrefix
```
String tablePrefix
```

Serialized Form

Package de.terrestris.shogun2.model

Class de.terrestris.shogun2.model.Application extends PersistentObject implements Serializable

Serialized Fields

name

description

language

open

active

url

viewport

Class de.terrestris.shogun2.model.File extends PersistentObject implements Serializable

Serialized Fields

active

fileName

fileType

file

Class de.terrestris.shogun2.model.ImageFile extends File implements Serializable

Serialized Fields

thumbnail

width

height

Class de.terrestris.shogun2.model.PersistentObject extends Object implements Serializable

Serialized Fields

id

created

modified

userPermissions

groupPermissions

Class de.terrestris.shogun2.model.Person extends PersistentObject implements Serializable

Serialized Fields

firstName

lastName

email

birthday

language

Class de.terrestris.shogun2.model.Role extends PersistentObject implements Serializable

Serialized Fields

name

description

Class de.terrestris.shogun2.model.Territory extends PersistentObject implements Serializable

Serialized Fields

name

geometry

Class de.terrestris.shogun2.model.User extends Person implements Serializable

Serialized Fields

accountName

password

active

roles

userGroups

Class de.terrestris.shogun2.model.UserGroup extends PersistentObject implements Serializable

Serialized Fields

name

owner

members

roles

Package de.terrestris.shogun2.model.interceptor

Class de.terrestris.shogun2.model.interceptor.InterceptorRule extends PersistentObject implements Serializable

Serialized Fields

event

rule

service

operation

endPoint

Package de.terrestris.shogun2.model.layer

Class de.terrestris.shogun2.model.layer.Layer extends PersistentObject implements Serializable

Serialized Fields

name

source

appearance

Package de.terrestris.shogun2.model.layer.appearance

Class de.terrestris.shogun2.model.layer.appearance.LayerAppearance extends PersistentObject implements Serializable

Serialized Fields

attribution

name

maxResolution

minResolution

opacity

visible