org.mapfish.print.attribute

Class PrimitiveAttribute<Value>

java.lang.Object

org.mapfish.print.attribute.PrimitiveAttribute<Value>

Type Parameters:

Value - The value type of the attribute

All Implemented Interfaces:

Attribute, ConfigurationObject

Direct Known Subclasses:

BooleanAttribute, FloatAttribute, IntegerAttribute, StringArrayAttribute, StringAttribute

public abstract class PrimitiveAttribute<Value>
extends java.lang.Object
implements Attribute

A type of attribute whose value is a primitive type.

• String
• Integer
• Float
• Double
• Short
• Boolean
• Character
• Byte
• Enum

Constructor Summary

Constructors

Constructor and Description
PrimitiveAttribute(java.lang.Class<Value> valueClass) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	clientConfigTypeDescription() Returns a string that is a technical description of the type.
Value	getDefault()
java.lang.Class<Value>	getValueClass()
void	printClientConfig(org.json.JSONWriter json, Template template) Write this attribute out the the json writer so that clients can know what attributes are expected.
void	setConfigName(java.lang.String configName) Set the name of the attribute as set in the configuration file.
void	setDefault(Value value) A default value for this attribute.
void	validate(java.util.List<java.lang.Throwable> validationErrors, Configuration configuration) validate that the configuration was correct.
void	validateValue(java.lang.Object value) Validation of the value from a request.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimitiveAttribute

public PrimitiveAttribute(java.lang.Class<Value> valueClass)

Constructor.

Parameters:

valueClass - the type of the value of this attribute

Method Detail

getValueClass

public final java.lang.Class<Value> getValueClass()

setDefault

public final void setDefault(Value value)

A default value for this attribute. Example:

     attributes:
       title: !string
         default: "Report"

Parameters:

value - The default value.

getDefault

public final Value getDefault()

setConfigName

public final void setConfigName(java.lang.String configName)

Description copied from interface: Attribute

Set the name of the attribute as set in the configuration file.

Specified by:

setConfigName in interface Attribute

Parameters:

configName - the name of the attribute

validate

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

Description copied from interface: ConfigurationObject

validate that the configuration was correct.

Specified by:

validate in interface ConfigurationObject

Parameters:

validationErrors - a list to add any detected errors to.

configuration - the containing configuration

validateValue

public void validateValue(java.lang.Object value)

Validation of the value from a request.

Parameters:

value - The value from a request.

printClientConfig

public final void printClientConfig(org.json.JSONWriter json,
                     Template template)
                             throws org.json.JSONException

Description copied from interface: Attribute

Write this attribute out the the json writer so that clients can know what attributes are expected.

Specified by:

printClientConfig in interface Attribute

Parameters:

json - the json writer to write to

template - the template that this attribute is part of

Throws:

org.json.JSONException

clientConfigTypeDescription

protected java.lang.String clientConfigTypeDescription()

Returns a string that is a technical description of the type. In other words, a string that the client software (user of the capabilities response) can use to create a request or UI. CSOFF: DesignForExtension