org.mapfish.print.attribute.map

Class OverviewMapAttribute

java.lang.Object

org.mapfish.print.attribute.ReflectiveAttribute<GenericMapAttribute.GenericMapAttributeValues>

org.mapfish.print.attribute.map.GenericMapAttribute

org.mapfish.print.attribute.map.OverviewMapAttribute

All Implemented Interfaces:

Attribute, ConfigurationObject

public final class OverviewMapAttribute
extends GenericMapAttribute

The attributes for an overview map (see !createOverviewMap processor).

[[examples=verboseExample,overviewmap_tyger_ny_EPSG_3857]]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OverviewMapAttribute.OverviewMapAttributeValues The value of MapAttribute.

Nested classes/interfaces inherited from class org.mapfish.print.attribute.map.GenericMapAttribute

GenericMapAttribute.GenericMapAttributeValues

Field Summary

Fields inherited from class org.mapfish.print.attribute.map.GenericMapAttribute

JSON_DPI_SUGGESTIONS, JSON_MAP_HEIGHT, JSON_MAP_WIDTH, JSON_MAX_DPI, JSON_MAX_HEIGHT, JSON_MAX_WIDTH

Fields inherited from class org.mapfish.print.attribute.ReflectiveAttribute

JSON_ATTRIBUTE_DEFAULT, JSON_ATTRIBUTE_EMBEDDED_TYPE, JSON_ATTRIBUTE_IS_ARRAY, JSON_ATTRIBUTE_TYPE, JSON_CLIENT_INFO, JSON_CLIENT_PARAMS, JSON_NAME

Constructor Summary

Constructors

Constructor and Description
OverviewMapAttribute()

Method Summary

Modifier and Type	Method and Description
OverviewMapAttribute.OverviewMapAttributeValues	createValue(Template template) Create an instance of a attribute value object.
java.lang.Class<OverviewMapAttribute.OverviewMapAttributeValues>	getValueType() Return the type created by ReflectiveAttribute.createValue(Template).
void	setStyle(java.lang.String style) The style name of a style to apply to the bbox rectangle of the original map during rendering.
void	setZoomFactor(double zoomFactor) The zoom factor by which the extent of the main map will be augmented to create an overview.

Methods inherited from class org.mapfish.print.attribute.map.GenericMapAttribute

getClientInfo, getDpiSuggestions, getHeight, getMaxDpi, getMaxHeight, getMaxWidth, getWidth, parseProjection, setDpiSuggestions, setHeight, setMaxDpi, setMaxHeight, setMaxWidth, setWidth, setZoomLevels, setZoomLevelSnapStrategy, setZoomSnapGeodetic, setZoomSnapTolerance, validate

Methods inherited from class org.mapfish.print.attribute.ReflectiveAttribute

getAttributeName, getDefaultValue, getValue, printClientConfig, setConfigName, setDefault

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OverviewMapAttribute

public OverviewMapAttribute()

Method Detail

setZoomFactor

public void setZoomFactor(double zoomFactor)

The zoom factor by which the extent of the main map will be augmented to create an overview.

Parameters:

zoomFactor - The zoom-factor.

setStyle

public void setStyle(java.lang.String style)

The style name of a style to apply to the bbox rectangle of the original map during rendering. The style name must map to a style in the template or the configuration objects.

Parameters:

style - The style.

getValueType

public java.lang.Class<OverviewMapAttribute.OverviewMapAttributeValues> getValueType()

Description copied from class: ReflectiveAttribute

Return the type created by ReflectiveAttribute.createValue(Template).

Specified by:

getValueType in interface Attribute

Specified by:

getValueType in class ReflectiveAttribute<GenericMapAttribute.GenericMapAttributeValues>

Returns:

the value class

createValue

public OverviewMapAttribute.OverviewMapAttributeValues createValue(Template template)

Description copied from class: ReflectiveAttribute

Create an instance of a attribute value object. Each instance must be new and unique. Instances must NOT be shared.

The object will be populated from the json. Each public field will be populated by looking up the value in the json.

If a field in the object has the HasDefaultValue annotation then no exception will be thrown if the json does not contain a value.

Fields in the object with the OneOf annotation must have one of the fields in the request data.

• String
• Integer
• Float
• Double
• Short
• Boolean
• Character
• Byte
• Enum
• PJsonObject
• URL
• Any enum
• PJsonArray
• any type with a 0 argument constructor
• array of any of the above (String[], boolean[], PJsonObject[], ...)

If there is a public () method then it will be called after the fields are all set.

In the case where the a parameter type is a normal POJO (not a special case like PJsonObject, URL, enum, double, etc...) then it will be assumed that the json data is a json object and the parameters will be recursively parsed into the new object as if it is also MapLayer parameter object.

It is important to put values in the value object as public fields because reflection is used when printing client config as well as generating documentation. If a field is intended for the client software as information but is not intended to be set (or sent as part of the request data), the field can be a final field.

Specified by:

createValue in class ReflectiveAttribute<GenericMapAttribute.GenericMapAttributeValues>

Parameters:

template - the template that this attribute is part of.