OnmsMap (OpenNMS 16.0.2 API)

java.lang.Object
- org.opennms.netmgt.model.OnmsMap

All Implemented Interfaces:

Serializable
```
@Entity
public class OnmsMap
extends Object
implements Serializable
```
OnmsMap class.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_MODE_ADMIN` Constant `ACCESS_MODE_ADMIN="RW"`
`static String`	`ACCESS_MODE_GROUP` Constant `ACCESS_MODE_GROUP="RWRO"`
`static String`	`ACCESS_MODE_USER` Constant `ACCESS_MODE_USER="RO"`
`static String`	`AUTOMATIC_SAVED_MAP` Constant `AUTOMATIC_SAVED_MAP="S"`
`static String`	`AUTOMATICALLY_GENERATED_MAP` Constant `AUTOMATICALLY_GENERATED_MAP="A"`
`static String`	`DELETED_MAP` Constant `DELETED_MAP="D"`
`static String`	`USER_GENERATED_MAP` Constant `USER_GENERATED_MAP="U"`

Constructor Summary

Constructors
Constructor and Description
`OnmsMap()` Constructor for OnmsMap.
`OnmsMap(String name, String owner)` Constructor for OnmsMap.
`OnmsMap(String name, String owner, int width, int height)` Constructor for OnmsMap.
`OnmsMap(String name, String owner, String accessMode, int width, int height)` Constructor for OnmsMap.
`OnmsMap(String name, String mapGroup, String background, String owner, String accessMode, String type, int width, int height)` Constructor for OnmsMap.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMapElement(OnmsMapElement element)` addMapElement
`String`	`getAccessMode()` Getter for the field `accessMode`.
`String`	`getBackground()` Getter for the field `background`.
`Date`	`getCreateTime()` Getter for the field `createTime`.
`int`	`getHeight()` Getter for the field `height`.
`int`	`getId()` Getter for the field `id`.
`Date`	`getLastModifiedTime()` Getter for the field `lastModifiedTime`.
`Set<OnmsMapElement>`	`getMapElements()` Getter for the field `mapElements`.
`String`	`getMapGroup()` Getter for the field `mapGroup`.
`String`	`getMapId()` getMapId
`String`	`getName()` Getter for the field `name`.
`int`	`getOffsetX()` Getter for the field `offsetX`.
`int`	`getOffsetY()` Getter for the field `offsetY`.
`String`	`getOwner()` Getter for the field `owner`.
`float`	`getScale()` Getter for the field `scale`.
`String`	`getType()` Getter for the field `type`.
`String`	`getUserLastModifies()` Getter for the field `userLastModifies`.
`int`	`getWidth()` Getter for the field `width`.
`void`	`setAccessMode(String accessMode)` Setter for the field `accessMode`.
`void`	`setBackground(String background)` Setter for the field `background`.
`void`	`setCreateTime(Date createTime)` Setter for the field `createTime`.
`void`	`setHeight(int height)` Setter for the field `height`.
`void`	`setId(int id)` Setter for the field `id`.
`void`	`setLastModifiedTime(Date lastModifiedTime)` Setter for the field `lastModifiedTime`.
`void`	`setMapElements(Set<OnmsMapElement> mapElements)` Setter for the field `mapElements`.
`void`	`setMapGroup(String mapGroup)` Setter for the field `mapGroup`.
`void`	`setName(String name)` Setter for the field `name`.
`void`	`setOffsetX(int offsetX)` Setter for the field `offsetX`.
`void`	`setOffsetY(int offsetY)` Setter for the field `offsetY`.
`void`	`setOwner(String owner)` Setter for the field `owner`.
`void`	`setScale(float scale)` Setter for the field `scale`.
`void`	`setType(String type)` Setter for the field `type`.
`void`	`setUserLastModifies(String userLastModifies)` Setter for the field `userLastModifies`.
`void`	`setWidth(int width)` Setter for the field `width`.

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

- Field Detail
  - USER_GENERATED_MAP
```
public static final String USER_GENERATED_MAP
```
    Constant USER_GENERATED_MAP="U"
    
    See Also:
    
    Constant Field Values
  - AUTOMATICALLY_GENERATED_MAP
```
public static final String AUTOMATICALLY_GENERATED_MAP
```
    Constant AUTOMATICALLY_GENERATED_MAP="A"
    
    See Also:
    
    Constant Field Values
  - AUTOMATIC_SAVED_MAP
```
public static final String AUTOMATIC_SAVED_MAP
```
    Constant AUTOMATIC_SAVED_MAP="S"
    
    See Also:
    
    Constant Field Values
  - DELETED_MAP
```
public static final String DELETED_MAP
```
    Constant DELETED_MAP="D"
    
    See Also:
    
    Constant Field Values
  - ACCESS_MODE_ADMIN
```
public static final String ACCESS_MODE_ADMIN
```
    Constant ACCESS_MODE_ADMIN="RW"
    
    See Also:
    
    Constant Field Values
  - ACCESS_MODE_USER
```
public static final String ACCESS_MODE_USER
```
    Constant ACCESS_MODE_USER="RO"
    
    See Also:
    
    Constant Field Values
  - ACCESS_MODE_GROUP
```
public static final String ACCESS_MODE_GROUP
```
    Constant ACCESS_MODE_GROUP="RWRO"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OnmsMap
```
public OnmsMap()
```
    Constructor for OnmsMap.
  - OnmsMap
```
public OnmsMap(String name,
               String owner)
```
    Constructor for OnmsMap.
    
    Parameters:
    
    name - a String object.
    
    owner - a String object.
  - OnmsMap
```
public OnmsMap(String name,
               String owner,
               int width,
               int height)
```
    Constructor for OnmsMap.
    
    Parameters:
    
    name - a String object.
    
    owner - a String object.
    
    width - a int.
    
    height - a int.
  - OnmsMap
```
public OnmsMap(String name,
               String owner,
               String accessMode,
               int width,
               int height)
```
    Constructor for OnmsMap.
    
    Parameters:
    
    name - a String object.
    
    owner - a String object.
    
    accessMode - a String object.
    
    width - a int.
    
    height - a int.
  - OnmsMap
```
public OnmsMap(String name,
               String mapGroup,
               String background,
               String owner,
               String accessMode,
               String type,
               int width,
               int height)
```
    Constructor for OnmsMap.
    
    Parameters:
    
    name - a String object.
    
    mapGroup - a String object.
    
    background - a String object.
    
    owner - a String object.
    
    accessMode - a String object.
    
    type - a String object.
    
    width - a int.
    
    height - a int.
- Method Detail
  - getId
```
public int getId()
```
    Getter for the field id.
    
    Returns:
    
    a int.
  - getMapId
```
public String getMapId()
```
    getMapId
    
    Returns:
    
    a String object.
  - setId
```
public void setId(int id)
```
    Setter for the field id.
    
    Parameters:
    
    id - a int.
  - getName
```
public String getName()
```
    Getter for the field name.
    
    Returns:
    
    a String object.
  - setName
```
public void setName(String name)
```
    Setter for the field name.
    
    Parameters:
    
    name - a String object.
  - getMapGroup
```
public String getMapGroup()
```
    Getter for the field mapGroup.
    
    Returns:
    
    a String object.
  - setMapGroup
```
public void setMapGroup(String mapGroup)
```
    Setter for the field mapGroup.
    
    Parameters:
    
    mapGroup - a String object.
  - getBackground
```
public String getBackground()
```
    Getter for the field background.
    
    Returns:
    
    a String object.
  - setBackground
```
public void setBackground(String background)
```
    Setter for the field background.
    
    Parameters:
    
    background - a String object.
  - getOwner
```
public String getOwner()
```
    Getter for the field owner.
    
    Returns:
    
    a String object.
  - setOwner
```
public void setOwner(String owner)
```
    Setter for the field owner.
    
    Parameters:
    
    owner - a String object.
  - getAccessMode
```
public String getAccessMode()
```
    Getter for the field accessMode.
    
    Returns:
    
    a String object.
  - setAccessMode
```
public void setAccessMode(String accessMode)
```
    Setter for the field accessMode.
    
    Parameters:
    
    accessMode - a String object.
  - getUserLastModifies
```
public String getUserLastModifies()
```
    Getter for the field userLastModifies.
    
    Returns:
    
    a String object.
  - setUserLastModifies
```
public void setUserLastModifies(String userLastModifies)
```
    Setter for the field userLastModifies.
    
    Parameters:
    
    userLastModifies - a String object.
  - getCreateTime
```
public Date getCreateTime()
```
    Getter for the field createTime.
    
    Returns:
    
    a Date object.
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
    Setter for the field createTime.
    
    Parameters:
    
    createTime - a Date object.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    Getter for the field lastModifiedTime.
    
    Returns:
    
    a Date object.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    Setter for the field lastModifiedTime.
    
    Parameters:
    
    lastModifiedTime - a Date object.
  - getScale
```
public float getScale()
```
    Getter for the field scale.
    
    Returns:
    
    a float.
  - setScale
```
public void setScale(float scale)
```
    Setter for the field scale.
    
    Parameters:
    
    scale - a float.
  - getOffsetX
```
public int getOffsetX()
```
    Getter for the field offsetX.
    
    Returns:
    
    a int.
  - setOffsetX
```
public void setOffsetX(int offsetX)
```
    Setter for the field offsetX.
    
    Parameters:
    
    offsetX - a int.
  - getOffsetY
```
public int getOffsetY()
```
    Getter for the field offsetY.
    
    Returns:
    
    a int.
  - setOffsetY
```
public void setOffsetY(int offsetY)
```
    Setter for the field offsetY.
    
    Parameters:
    
    offsetY - a int.
  - getType
```
public String getType()
```
    Getter for the field type.
    
    Returns:
    
    a String object.
  - setType
```
public void setType(String type)
```
    Setter for the field type.
    
    Parameters:
    
    type - a String object.
  - getWidth
```
public int getWidth()
```
    Getter for the field width.
    
    Returns:
    
    a int.
  - setWidth
```
public void setWidth(int width)
```
    Setter for the field width.
    
    Parameters:
    
    width - a int.
  - getHeight
```
public int getHeight()
```
    Getter for the field height.
    
    Returns:
    
    a int.
  - setHeight
```
public void setHeight(int height)
```
    Setter for the field height.
    
    Parameters:
    
    height - a int.
  - getMapElements
```
public Set<OnmsMapElement> getMapElements()
```
    Getter for the field mapElements.
    
    Returns:
    
    a Set object.
  - setMapElements
```
public void setMapElements(Set<OnmsMapElement> mapElements)
```
    Setter for the field mapElements.
    
    Parameters:
    
    mapElements - a Set object.
  - addMapElement
```
public void addMapElement(OnmsMapElement element)
```
    addMapElement
    
    Parameters:
    
    element - a OnmsMapElement object.

Class OnmsMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_GENERATED_MAP

AUTOMATICALLY_GENERATED_MAP

AUTOMATIC_SAVED_MAP

DELETED_MAP

ACCESS_MODE_ADMIN

ACCESS_MODE_USER

ACCESS_MODE_GROUP

Constructor Detail

OnmsMap

OnmsMap

OnmsMap

OnmsMap

OnmsMap

Method Detail

getId

getMapId

setId

getName

setName

getMapGroup

setMapGroup

getBackground

setBackground

getOwner

setOwner

getAccessMode

setAccessMode

getUserLastModifies

setUserLastModifies

getCreateTime

setCreateTime

getLastModifiedTime

setLastModifiedTime

getScale

setScale

getOffsetX

setOffsetX

getOffsetY

setOffsetY

getType

setType

getWidth

setWidth

getHeight

setHeight

getMapElements

setMapElements

addMapElement