org.opengis.parameter

Interface Parameter<T>

Type Parameters:

T -

All Known Implementing Classes:

DataAccessFactory.Param, Parameter, WFSDataAccessFactory.WFSFactoryParam

public interface Parameter<T>

General parameter interface.

Author:

Justin Deoliveira, OpenGeo

Method Summary

Modifier and Type	Method and Description
T	getDefaultValue() A default value for the parameter.
InternationalString	getDescription() Description of the parameter.
int	getMaxOccurs() The maximum number of occurrences of the parameter.
int	getMinOccurs() The minimum number of occurrences of the parameter.
String	getName() Name of the parameter.
InternationalString	getTitle() Title of the parameter.
Class<T>	getType() Type/class of the parameter.
Boolean	isRequired() Flag indicating if the parameter is required or not.

Method Detail

getName

String getName()

Name of the parameter.

getTitle

InternationalString getTitle()

Title of the parameter.

getDescription

InternationalString getDescription()

Description of the parameter.

getType

Class<T> getType()

Type/class of the parameter.

isRequired

Boolean isRequired()

Flag indicating if the parameter is required or not.

getMinOccurs

int getMinOccurs()

The minimum number of occurrences of the parameter.

Returns:

minimum number of occurrences, or -1 if no minimum needed

getMaxOccurs

int getMaxOccurs()

The maximum number of occurrences of the parameter.

Returns:

maximum number of occurences, or -1 for unbound

getDefaultValue

T getDefaultValue()

A default value for the parameter.