org.mapfish.print.attribute

Class LegendAttribute

java.lang.Object

org.mapfish.print.attribute.ReflectiveAttribute<LegendAttribute.LegendAttributeValue>

org.mapfish.print.attribute.LegendAttribute

All Implemented Interfaces:

Attribute, ConfigurationObject

public final class LegendAttribute
extends ReflectiveAttribute<LegendAttribute.LegendAttributeValue>

Objects needed by the LegendProcessor (see !prepareLegend processor). [[examples=verboseExample,legend_cropped]]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LegendAttribute.LegendAttributeValue The data required to render a map legend.

Field Summary

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
LegendAttribute()

Method Summary

Modifier and Type	Method and Description
LegendAttribute.LegendAttributeValue	createValue(Template template) Create an instance of a attribute value object.
java.lang.Class<LegendAttribute.LegendAttributeValue>	getValueType() Return the type created by ReflectiveAttribute.createValue(org.mapfish.print.config.Template).
void	validate(java.util.List<java.lang.Throwable> validationErrors, Configuration configuration) validate that the configuration was correct.

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

getAttributeName, getClientInfo, 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

LegendAttribute

public LegendAttribute()

Method Detail

getValueType

public java.lang.Class<LegendAttribute.LegendAttributeValue> getValueType()

Description copied from class: ReflectiveAttribute

Return the type created by ReflectiveAttribute.createValue(org.mapfish.print.config.Template).

Specified by:

getValueType in interface Attribute

Specified by:

getValueType in class ReflectiveAttribute<LegendAttribute.LegendAttributeValue>

Returns:

the value class

createValue

public LegendAttribute.LegendAttributeValue 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<LegendAttribute.LegendAttributeValue>

Parameters:

template - the template that this attribute is part of.

validate

public void validate(java.util.List<java.lang.Throwable> validationErrors,
                     Configuration configuration)

Description copied from interface: ConfigurationObject

validate that the configuration was correct.

Parameters:

validationErrors - a list to add any detected errors to.

configuration - the containing configuration