Project (JMap 7.0 Kathmandu API Documentation)

java.lang.Object
- com.kheops.jmap.metadata.LocalizedObject
- - com.kheops.jmap.metadata.Project

All Implemented Interfaces:

java.io.ObjectInputValidation, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Project>
```
public class Project
extends LocalizedObject
implements java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Project>, java.io.ObjectInputValidation
```
This class encapsulates the information about a project on JMapServer.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static double DEFAULT_MAXIMUM_SCALE

static double DEFAULT_MINIMUM_SCALE

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_MAXIMUM_SCALE`
`static double`	`DEFAULT_MINIMUM_SCALE`

Constructor Summary

Constructors
Constructor and Description
`Project(int id)` Constructs a new Project object with the specified parameters.
`Project(int id, java.lang.String name, java.lang.String desc, JMapUnit mapUnit, JMapUnit distanceUnit, OrientedRectangle viewBounds)` Constructs a new Project object with the specified parameters.
`Project(int id, java.lang.String name, java.lang.String desc, JMapUnit mapUnit, JMapUnit distanceUnit, OrientedRectangle viewBounds, JMapUnit displayUnit)` Constructs a new Project object with the specified parameters.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Overrides clone to return a new instance of Project that is the exact copy of the caller
`int`	`compareTo(Project o)` Implementation of the interface Comparable
`java.util.List<java.lang.String>`	`getAvailableLanguages()`
`java.lang.String`	`getDefaultLanguage()`
`ViewSettings`	`getDefaultViewSettings()` Gets a ViewSetting instance containing the default view settings.
`java.lang.String`	`getDescription()` Gets the description.
`java.lang.String`	`getDescription(java.util.Locale locale)` Gets the description of this project for a specific locale.
`JMapUnit`	`getDistanceUnit()` Retrieves the unit used in the project
`int`	`getId()` Gets the project id.
`java.awt.Color`	`getInitialBGColor()` Retrieves the default background color of the project
`OrientedRectangle`	`getInitialExtent()` Retrieves the bounding area of the project
`OrientedRectangle`	`getInitialViewBounds()` Deprecated. use getInitialExtent() instead.
`JMapUnit`	`getMapUnit()` Retrieves the unit used in the project
`OrientedRectangle`	`getMaximumExtent()` Retrieves the defined maximum area of the project.
`double`	`getMaximumScale()` Retrieves the maximum scale of the project.
`double`	`getMinimumScale()` Retrieves the minimum scale of the project.
`java.lang.String`	`getName()` Gets the name of this project.
`java.lang.String`	`getName(java.util.Locale locale)` Gets the name of this project for a specific locale.
`boolean`	`getPreventLabelsOverlapping()` Returns the value of the preventLabelsOverlapping flag.
`boolean`	`isNamed(java.lang.String value)` Checks if the project is named (including available translations, case insensitive) as the specified value.
`void`	`removeTranslationsOtherThan(java.util.Locale[] locales)` Removes any `Locale` from this object that are not in the specified `locales`.
`void`	`setDescription(java.lang.String description)` Sets the Description
`void`	`setDescription(java.lang.String description, java.util.Locale locale)` Sets the description of this project for the specified Locale.
`void`	`setDistanceUnit(JMapUnit unit)` Sets the unit used in the project
`void`	`setId(int id)` Sets the project id.
`void`	`setInitialBGColor(java.awt.Color color)` Sets the default background color of the project
`void`	`setInitialExtent(OrientedRectangle extent)` Sets the bounding area of the project
`void`	`setInitialViewBounds(OrientedRectangle extent)` Deprecated. use setInitialExtent(OrientedRectangle extent) instead.
`void`	`setMapUnit(JMapUnit unit)` Sets the unit used in the project
`void`	`setMaximumExtent(OrientedRectangle extent)` Sets the defined maximum area of the project.
`void`	`setMaximumScale(double maximumScale)` Sets the maximum scale of the project.
`void`	`setMinimumScale(double minimumScale)` Sets the minimum scale of the project.
`void`	`setName(java.lang.String name)` Sets the name of this project.
`void`	`setName(java.lang.String name, java.util.Locale locale)` Sets the name of this project for the specified Locale.
`void`	`setPreventLabelsOverlapping(boolean flag)` Sets the value of the preventLabelsOverlapping flag.
`java.lang.String`	`toString()`
`void`	`update(Project project)` This method update the project by setting the appropriate instance variable.
`void`	`validateObject()`

Methods inherited from class com.kheops.jmap.metadata.LocalizedObject
getAvailableLocales, getTranslation, isTranslationExists, setTranslation, updateTranslations

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

- Field Detail
  - DEFAULT_MINIMUM_SCALE
```
public static final double DEFAULT_MINIMUM_SCALE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAXIMUM_SCALE
```
public static final double DEFAULT_MAXIMUM_SCALE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Project
```
public Project(int id,
               java.lang.String name,
               java.lang.String desc,
               JMapUnit mapUnit,
               JMapUnit distanceUnit,
               OrientedRectangle viewBounds,
               JMapUnit displayUnit)
```
    Constructs a new Project object with the specified parameters.
    
    Parameters:
    
    id - the unique id of the project
    
    name - the name of the project
    
    desc - the description of the project
    
    mapUnit - the unit of the project
    
    distanceUnit - the distance unit of the project
    
    viewBounds - the bounding area of the data in the project
    
    displayUnit - the display unit for the view
  - Project
```
public Project(int id,
               java.lang.String name,
               java.lang.String desc,
               JMapUnit mapUnit,
               JMapUnit distanceUnit,
               OrientedRectangle viewBounds)
```
    Constructs a new Project object with the specified parameters.
    
    Parameters:
    
    id - the unique id of the project
    
    name - the name of the project
    
    desc - the description of the project
    
    mapUnit - the unit of the project
    
    viewBounds - the bounding area of the data in the project
  - Project
```
public Project(int id)
```
    Constructs a new Project object with the specified parameters.
    
    Parameters:
    
    id - the unique id of the project
- Method Detail
  - getInitialExtent
```
public OrientedRectangle getInitialExtent()
```
    Retrieves the bounding area of the project
    
    Returns:
    
    the bounding area of the project
  - getInitialViewBounds
```
@Deprecated
public OrientedRectangle getInitialViewBounds()
```
    Deprecated. use getInitialExtent() instead.
  - setInitialExtent
```
public void setInitialExtent(OrientedRectangle extent)
```
    Sets the bounding area of the project
    
    Parameters:
    
    extent - the new bounding area of the project
    
    See Also:
    
    OrientedRectangle
  - setInitialViewBounds
```
@Deprecated
public void setInitialViewBounds(OrientedRectangle extent)
```
    Deprecated. use setInitialExtent(OrientedRectangle extent) instead.
  - getMaximumExtent
```
public OrientedRectangle getMaximumExtent()
```
    Retrieves the defined maximum area of the project.
    
    Returns:
    
    the defined maximum area of the project
  - setMaximumExtent
```
public void setMaximumExtent(OrientedRectangle extent)
```
    Sets the defined maximum area of the project.
    
    Parameters:
    
    extent - the new defined maximum area of the project
    
    See Also:
    
    OrientedRectangle
  - getMapUnit
```
public JMapUnit getMapUnit()
```
    Retrieves the unit used in the project
    
    Returns:
    
    the unit used in the project
    
    See Also:
    
    JMapUnit
  - setMapUnit
```
public void setMapUnit(JMapUnit unit)
```
    Sets the unit used in the project
    
    Parameters:
    
    unit - the new unit used in the project
    
    See Also:
    
    JMapUnit
  - getDistanceUnit
```
public JMapUnit getDistanceUnit()
```
    Retrieves the unit used in the project
    
    Returns:
    
    the unit used in the project
    
    See Also:
    
    JMapUnit
  - setDistanceUnit
```
public void setDistanceUnit(JMapUnit unit)
```
    Sets the unit used in the project
    
    Parameters:
    
    unit - the new unit used in the project
    
    See Also:
    
    JMapUnit
  - getInitialBGColor
```
public java.awt.Color getInitialBGColor()
```
    Retrieves the default background color of the project
    
    Returns:
    
    the background color of the directory
  - setInitialBGColor
```
public void setInitialBGColor(java.awt.Color color)
```
    Sets the default background color of the project
    
    Parameters:
    
    color - background color of the directory
  - getMaximumScale
```
public double getMaximumScale()
```
    Retrieves the maximum scale of the project. Zoom operations beyond that value should not be allowed.
    
    Returns:
    
    the maximum scale of the project.
  - setMaximumScale
```
public void setMaximumScale(double maximumScale)
```
    Sets the maximum scale of the project. Zoom operations beyond that value should not be allowed.
    
    Parameters:
    
    maximumScale - the maximum scale to set.
  - getMinimumScale
```
public double getMinimumScale()
```
    Retrieves the minimum scale of the project. Zoom operations beyond that value should not be allowed.
    
    Returns:
    
    the minimum scale of the project.
  - setMinimumScale
```
public void setMinimumScale(double minimumScale)
```
    Sets the minimum scale of the project. Zoom operations beyond that value should not be allowed.
    
    Parameters:
    
    minimumScale - the minimum scale to set.
  - getId
```
public int getId()
```
    Gets the project id.
    
    Returns:
    
    the project id.
  - setId
```
public void setId(int id)
```
    Sets the project id.
    
    Parameters:
    
    id - the new project id.
  - getName
```
public java.lang.String getName()
```
    Gets the name of this project.
    
    Returns:
    
    name
  - getName
```
public java.lang.String getName(java.util.Locale locale)
```
    Gets the name of this project for a specific locale.
    
    Parameters:
    
    locale -
    
    Returns:
    
    name.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of this project.
    
    Parameters:
    
    name - the new given name.
  - setName
```
public void setName(java.lang.String name,
                    java.util.Locale locale)
```
    Sets the name of this project for the specified Locale.
    
    Parameters:
    
    name - the new given name.
    
    locale - the locale for this name
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description.
    
    Returns:
    
    the description string
  - getDescription
```
public java.lang.String getDescription(java.util.Locale locale)
```
    Gets the description of this project for a specific locale.
    
    Parameters:
    
    locale -
    
    Returns:
    
    name.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the Description
    
    Parameters:
    
    description - the associated description string.
  - setDescription
```
public void setDescription(java.lang.String description,
                           java.util.Locale locale)
```
    Sets the description of this project for the specified Locale.
    
    Parameters:
    
    description - the new given description.
    
    locale - the locale for this description
  - update
```
public void update(Project project)
```
    This method update the project by setting the appropriate instance variable.
    
    Parameters:
    
    project - the project instance containing the data that needs to be updated.
  - getDefaultViewSettings
```
public ViewSettings getDefaultViewSettings()
```
    Gets a ViewSetting instance containing the default view settings.
    
    Returns:
    
    the corresponding ViewSettings instance.
    
    See Also:
    
    ViewSettings
  - clone
```
public java.lang.Object clone()
```
    Overrides clone to return a new instance of Project that is the exact copy of the caller
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    the clone instance
  - setPreventLabelsOverlapping
```
public void setPreventLabelsOverlapping(boolean flag)
```
    Sets the value of the preventLabelsOverlapping flag. If preventOverlapping is active, labels will not overlap each others.
  - getPreventLabelsOverlapping
```
public boolean getPreventLabelsOverlapping()
```
    Returns the value of the preventLabelsOverlapping flag. If preventLabelsOverlapping is active, labels will not overlap each others.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public int compareTo(Project o)
```
    Implementation of the interface Comparable
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Project>
    
    Parameters:
    
    o - the object to compare with
    
    Returns:
    
    An integer. See Comparable for more details.
  - validateObject
```
public void validateObject()
```
    Specified by:
    
    validateObject in interface java.io.ObjectInputValidation
  - getDefaultLanguage
```
public java.lang.String getDefaultLanguage()
```
  - getAvailableLanguages
```
public java.util.List<java.lang.String> getAvailableLanguages()
```
  - isNamed
```
public boolean isNamed(java.lang.String value)
```
    Checks if the project is named (including available translations, case insensitive) as the specified value.
    
    Parameters:
    
    value -
    
    Returns:
  - removeTranslationsOtherThan
```
public void removeTranslationsOtherThan(java.util.Locale[] locales)
```
    Description copied from class: LocalizedObject
    
    Removes any Locale from this object that are not in the specified locales. locales[0] should be the default language
    
    Overrides:
    
    removeTranslationsOtherThan in class LocalizedObject

Class Project

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.kheops.jmap.metadata.LocalizedObject

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MINIMUM_SCALE

DEFAULT_MAXIMUM_SCALE

Constructor Detail

Project

Project

Project

Method Detail

getInitialExtent

getInitialViewBounds

setInitialExtent

setInitialViewBounds

getMaximumExtent

setMaximumExtent

getMapUnit

setMapUnit

getDistanceUnit

setDistanceUnit

getInitialBGColor

setInitialBGColor

getMaximumScale

setMaximumScale

getMinimumScale

setMinimumScale

getId

setId

getName

getName

setName

setName

getDescription

getDescription

setDescription

setDescription

update

getDefaultViewSettings

clone

setPreventLabelsOverlapping

getPreventLabelsOverlapping

toString

compareTo

validateObject

getDefaultLanguage

getAvailableLanguages

isNamed

removeTranslationsOtherThan