Package it.geosolutions.geoserver.rest.encoder.metadata.virtualtable

Class VTParameterEncoder

java.lang.Object

it.geosolutions.geoserver.rest.encoder.utils.XmlElement

it.geosolutions.geoserver.rest.encoder.metadata.virtualtable.VTParameterEncoder

public class VTParameterEncoder
extends XmlElement

VTParameterEncoder - Encodes a metadata VirtualTable parameter for a GeoServer featureType, as follows:

 { @code
        final VTParameterEncoder vtParam = new VTParameterEncoder();
        vtParam.setName("fieldname");
        vtParam.setDefaultValue("default_value");
        vtParam.setRegexpValidator("^[\\w\\d\\s]+$");
 }
 

For this example, the XML output is:

 
 <parameter>
 	<name>fieldname</name>
 	<defaultValue>default_value</defaultValue>
 	<regexpValidator>^[\w\d\s]+$</regexpValidator>
 </parameter>
 
 

Version:

$Id: $

Author:

Emmanuel Blondel - emmanuel.blondel1@gmail.com | emmanuel.blondel@fao.org

Constructor Summary

Constructors

Constructor	Description
VTParameterEncoder()	Constructs a GSVirtualTableParamEncoder
VTParameterEncoder(java.lang.String name, java.lang.String defaultValue, java.lang.String regexpValidator)	Constructs quickly a VTParameterEncoder

Method Summary

Modifier and Type	Method	Description
boolean	delDefaultValue()	Deletes the default value
protected boolean	delMember(VTParameter type)	Deletes a VirtualTableParameter member
boolean	delName()	Deletes the name
boolean	delRegexpValidator()	Deletes the Regexp validator
java.lang.String	getDefaultValue()	Get the parameter default value
static org.jdom.filter.Filter	getFilterByName(java.lang.String name)	Get a Filter using the VTParameter name
protected java.lang.String	getMember(VTParameter type)	Get a VirtualTableParameter member
java.lang.String	getName()	Get the parameter name
java.lang.String	getRegexpValidator()	Get the parameter regexp validator
void	setDefaultValue(java.lang.String value)	Set the parameter default value
protected void	setMember(VTParameter type, java.lang.String value)	Set a VirtualTableParameter member
void	setName(java.lang.String name)	Set the parameter name
void	setRegexpValidator(java.lang.String validator)	Set the parameter regexp validator
protected void	setup(java.lang.String name, java.lang.String defaultValue, java.lang.String regexpValidator)	Set-up quickly a VirtualTable parameter

Methods inherited from class it.geosolutions.geoserver.rest.encoder.utils.XmlElement

add, add, addContent, getRoot, isEmpty, remove, set, set, setRoot, setRoot, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

VTParameterEncoder

public VTParameterEncoder()

Constructs a GSVirtualTableParamEncoder

VTParameterEncoder

public VTParameterEncoder(java.lang.String name,
                          java.lang.String defaultValue,
                          java.lang.String regexpValidator)

Constructs quickly a VTParameterEncoder

Parameters:

name - (required)

defaultValue - (required)

regexpValidator - (required)

Method Detail

getFilterByName

public static org.jdom.filter.Filter getFilterByName(java.lang.String name)

Get a Filter using the VTParameter name

Parameters:

name - a String object.

Returns:

the filter

setup

protected void setup(java.lang.String name,
                     java.lang.String defaultValue,
                     java.lang.String regexpValidator)

Set-up quickly a VirtualTable parameter

Parameters:

name - a String object.

defaultValue - a String object.

regexpValidator - a String object.

setMember

protected void setMember(VTParameter type,
                         java.lang.String value)

Set a VirtualTableParameter member

Parameters:

type - a VTParameter object.

value - a String object.

setName

public void setName(java.lang.String name)

Set the parameter name

Parameters:

name - a String object.

setDefaultValue

public void setDefaultValue(java.lang.String value)

Set the parameter default value

Parameters:

value - a String object.

setRegexpValidator

public void setRegexpValidator(java.lang.String validator)

Set the parameter regexp validator

Parameters:

validator - a String object.

delMember

protected boolean delMember(VTParameter type)

Deletes a VirtualTableParameter member

Parameters:

type - a VTParameter object.

Returns:

a boolean.

delName

public boolean delName()

Deletes the name

Returns:

true if removed, false otherwise

delDefaultValue

public boolean delDefaultValue()

Deletes the default value

Returns:

true if removed, false otherwise

delRegexpValidator

public boolean delRegexpValidator()

Deletes the Regexp validator

Returns:

true if removed, false otherwise

getMember

protected java.lang.String getMember(VTParameter type)

Get a VirtualTableParameter member

Parameters:

type - a VTParameter object.

Returns:

a String object.

getName

public java.lang.String getName()

Get the parameter name

Returns:

a String object.

getDefaultValue

public java.lang.String getDefaultValue()

Get the parameter default value

Returns:

a String object.

getRegexpValidator

public java.lang.String getRegexpValidator()

Get the parameter regexp validator

Returns:

a String object.