NominatimSearch (SHOGun2 Core 0.1.0 API)

java.lang.Object
- de.terrestris.shogun2.model.PersistentObject
- - de.terrestris.shogun2.model.module.Module
  - - de.terrestris.shogun2.model.module.NominatimSearch

All Implemented Interfaces:

Serializable
```
@Entity
public class NominatimSearch
extends Module
```
A search module working with the OSM Nominatim Service.

Author:

Kai Volland

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NominatimSearch.NominatimFormatType
A enum type for the allowed response format.

Nested Classes
Modifier and Type	Class and Description
`static class`	`NominatimSearch.NominatimFormatType` A enum type for the allowed response format.

Constructor Summary

Constructors
Constructor and Description

NominatimSearch()
Explicitly adding the default constructor as this is important, e.g. for Hibernate: http://goo.gl/3Cr1pw

Constructors
Constructor and Description
`NominatimSearch()` Explicitly adding the default constructor as this is important, e.g. for Hibernate: http://goo.gl/3Cr1pw

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`NominatimSearch.NominatimFormatType`	`getFormat()`
`String`	`getGroupHeaderTpl()`
`Integer`	`getMinSearchTextChars()`
`Integer`	`getResultLimit()`
`Integer`	`getTypeDelay()`
`List<Integer>`	`getViewboxlbrt()`
`int`	`hashCode()`
`void`	`setFormat(NominatimSearch.NominatimFormatType format)`
`void`	`setGroupHeaderTpl(String groupHeaderTpl)`
`void`	`setMinSearchTextChars(Integer minSearchTextChars)`
`void`	`setResultLimit(Integer resultLimit)`
`void`	`setTypeDelay(Integer typeDelay)`
`void`	`setViewboxlbrt(List<Integer> viewboxlbrt)`
`String`	`toString()`

Methods inherited from class de.terrestris.shogun2.model.module.Module
getName, getProperties, getXtype, setName, setProperties, setXtype

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

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

- Constructor Detail
  - NominatimSearch
```
public NominatimSearch()
```
    Explicitly adding the default constructor as this is important, e.g. for Hibernate: http://goo.gl/3Cr1pw
- Method Detail
  - getFormat
```
public NominatimSearch.NominatimFormatType getFormat()
```
    Returns:
    
    the format
  - setFormat
```
public void setFormat(NominatimSearch.NominatimFormatType format)
```
    Parameters:
    
    format - the format to set
  - getResultLimit
```
public Integer getResultLimit()
```
    Returns:
    
    the resultLimit
  - setResultLimit
```
public void setResultLimit(Integer resultLimit)
```
    Parameters:
    
    resultLimit - the resultLimit to set
  - getViewboxlbrt
```
public List<Integer> getViewboxlbrt()
```
    Returns:
    
    the viewboxlbrt
  - setViewboxlbrt
```
public void setViewboxlbrt(List<Integer> viewboxlbrt)
```
    Parameters:
    
    viewboxlbrt - the viewboxlbrt to set
  - getMinSearchTextChars
```
public Integer getMinSearchTextChars()
```
    Returns:
    
    the minSearchTextChars
  - setMinSearchTextChars
```
public void setMinSearchTextChars(Integer minSearchTextChars)
```
    Parameters:
    
    minSearchTextChars - the minSearchTextChars to set
  - getTypeDelay
```
public Integer getTypeDelay()
```
    Returns:
    
    the typeDelay
  - setTypeDelay
```
public void setTypeDelay(Integer typeDelay)
```
    Parameters:
    
    typeDelay - the typeDelay to set
  - getGroupHeaderTpl
```
public String getGroupHeaderTpl()
```
    Returns:
    
    the groupHeaderTpl
  - setGroupHeaderTpl
```
public void setGroupHeaderTpl(String groupHeaderTpl)
```
    Parameters:
    
    groupHeaderTpl - the groupHeaderTpl to set
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Module
    
    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 Module
    
    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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Module

Class NominatimSearch

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class de.terrestris.shogun2.model.module.Module

Methods inherited from class de.terrestris.shogun2.model.PersistentObject

Methods inherited from class java.lang.Object

Constructor Detail

NominatimSearch

Method Detail

getFormat

setFormat

getResultLimit

setResultLimit

getViewboxlbrt

setViewboxlbrt

getMinSearchTextChars

setMinSearchTextChars

getTypeDelay

setTypeDelay

getGroupHeaderTpl

setGroupHeaderTpl

hashCode

equals

toString