org.opengis.cite.cat30.opensearch

Class TemplateParamInfo

java.lang.Object

org.opengis.cite.cat30.opensearch.TemplateParamInfo

public class TemplateParamInfo
extends Object

Provides information about a URL template parameter appearing in an OpenSearch description document.

See Also:

OpenSearch URL template syntax

Constructor Summary

Constructors

Constructor and Description
TemplateParamInfo() Default constructor sets the parameter type to be String with a zero-length string as the default value.
TemplateParamInfo(QName name, boolean isRequired) Constructs a new TemplateParamInfo with the given qualified name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object that)
Object	getDefaultValue() Get the default value of the parameter.
QName	getName() Get the qualified name of the parameter.
Class	getType() Get the data type of the parameter.
int	hashCode()
boolean	isRequired() Get the value of isRequired
void	setDefaultValue(Object defaultValue) Set the default value of the parameter.
void	setIsRequired(boolean isRequired) Set the value of isRequired
void	setName(QName name) Set the (qualified) name of the parameter.
void	setType(Class type) Set the data type of the parameter (java.lang.String by default).

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateParamInfo

public TemplateParamInfo()

Default constructor sets the parameter type to be String with a zero-length string as the default value.

TemplateParamInfo

public TemplateParamInfo(QName name,
                 boolean isRequired)

Constructs a new TemplateParamInfo with the given qualified name.

Parameters:

name - A QName representing the name of the parameter.

isRequired - A boolean value indicating whether or not the parameter is required.

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object that)

Overrides:

equals in class Object

getDefaultValue

public Object getDefaultValue()

Get the default value of the parameter.

Returns:

A instance of the parameter's type, or a zero-length string if it has not been set.

setDefaultValue

public void setDefaultValue(Object defaultValue)

Set the default value of the parameter.

Parameters:

defaultValue - A type-compatible value.

getType

public Class getType()

Get the data type of the parameter.

Returns:

The parameter type.

setType

public void setType(Class type)

Set the data type of the parameter (java.lang.String by default).

Parameters:

type - The new data type.

isRequired

public boolean isRequired()

Get the value of isRequired

Returns:

the value of isRequired

setIsRequired

public void setIsRequired(boolean isRequired)

Set the value of isRequired

Parameters:

isRequired - new value of isRequired

getName

public QName getName()

Get the qualified name of the parameter.

Returns:

A QName object specifying a name.

setName

public void setName(QName name)

Set the (qualified) name of the parameter.

Parameters:

name - A QName object.