Module (SHOGun-Core (Main) 5.3.7 API)

java.lang.Object
- de.terrestris.shoguncore.model.PersistentObject
- - de.terrestris.shoguncore.model.module.Module

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Button, CompositeModule, CoordinateTransformation, Image, Map, NominatimSearch, OverpassSearch, OverviewMap, Print, WfsSearch
```
@Entity
public class Module
extends PersistentObject
```
A module is the visual representation of a component in the GUI. A module can be connected to a Layout and it stores basic properties (like border, height , width, ...).
This class is the simple base class of either simple (e.g. LayerTree) or complex (CompositeModule) subclasses and can thereby considered as a node in a tree structure of (sub-)modules.

Author:

Nils Bühner

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Module()
Explicitly adding the default constructor as this is important, e.g.

Module(String name)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`String`	`getName()`
`Map<String,Object>`	`getProperties()`
`String`	`getXtype()`
`int`	`hashCode()`
`void`	`setName(String name)`
`void`	`setProperties(Map<String,Object> properties)`
`void`	`setXtype(String xtype)`

Methods inherited from class de.terrestris.shoguncore.model.PersistentObject
getCreated, getGroupPermissions, getId, getModified, getUserPermissions, setGroupPermissions, setModified, setUserPermissions, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Module
```
public Module()
```
    Explicitly adding the default constructor as this is important, e.g. for Hibernate: http://goo.gl/3Cr1pw
  - Module
```
public Module(String name)
```
- Method Detail
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    Parameters:
    
    name - the name to set
  - getXtype
```
public String getXtype()
```
    Returns:
    
    the xtype
  - setXtype
```
public void setXtype(String xtype)
```
    Parameters:
    
    xtype - the xtype to set
  - getProperties
```
public Map<String,Object> getProperties()
```
    Returns:
    
    the properties
  - setProperties
```
public void setProperties(Map<String,Object> properties)
```
    Parameters:
    
    properties - the properties to set
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class PersistentObject
    
    See Also:
    
    According to http://stackoverflow.com/questions/27581/overriding-equals -and-hashcode-in-java it is recommended only to use getter-methods when using ORM like Hibernate
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class PersistentObject
    
    See Also:
    
    According to http://stackoverflow.com/questions/27581/overriding-equals -and-hashcode-in-java it is recommended only to use getter-methods when using ORM like Hibernate