com.mapinfo.geocode

Class InputParameter

java.lang.Object

com.mapinfo.geocode.InputParameter

All Implemented Interfaces:

InputParam, Serializable

public class InputParameter
extends Object
implements InputParam

This class implements the InputParam interface. It is used for describing the input of an Operation in the Capabilities feature

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InputParameter()
InputParameter(InputParam copy)

Method Summary

Modifier and Type	Method and Description
List<Pair<String,String>>	getAllowedValuesWithDescriptions() Get allowed values and their descriptions of input parameter.
String	getDefaultValue() Get default value of input parameter
String	getDescription() Get description of input parameterN
String	getHighBoundary() Get high boundary of input parameter, where boundary applies
String	getLowBoundary() Get low boundary of input parameter, where boundary applies
String	getName() Get name of input parameter
String	getType() Get type of input parameter
void	setAllowedValuesWithDescriptions(List<Pair<String,String>> values) Set allowed values and their descriptions of input parameter
void	setDefaultValue(String defaultValue) Set default value of input parameter
void	setDescription(String desc) Set description of input parameter
void	setHighBoundary(String highBoundary) Set high boundary of input parameter
void	setLowBoundary(String lowBoundary) Set low boundary of input parameter
void	setName(String name) Set name of input parameter
void	setType(String type) Set type of input parameter
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InputParameter

public InputParameter()

InputParameter

public InputParameter(InputParam copy)

Method Detail

getName

public String getName()

Description copied from interface: InputParam

Get name of input parameter

Specified by:

getName in interface InputParam

Returns:

name of input parameter

setName

public void setName(String name)

Description copied from interface: InputParam

Set name of input parameter

Specified by:

setName in interface InputParam

Parameters:

name - - name of input parameter

getDescription

public String getDescription()

Description copied from interface: InputParam

Get description of input parameterN

Specified by:

getDescription in interface InputParam

Returns:

description of input parameter

setDescription

public void setDescription(String desc)

Description copied from interface: InputParam

Set description of input parameter

Specified by:

setDescription in interface InputParam

Parameters:

desc - - description of input parameter

getType

public String getType()

Description copied from interface: InputParam

Get type of input parameter

Specified by:

getType in interface InputParam

Returns:

type of input parameter

setType

public void setType(String type)

Description copied from interface: InputParam

Set type of input parameter

Specified by:

setType in interface InputParam

Parameters:

type - - type of input parameter

getDefaultValue

public String getDefaultValue()

Description copied from interface: InputParam

Get default value of input parameter

Specified by:

getDefaultValue in interface InputParam

Returns:

default value of input parameter

setDefaultValue

public void setDefaultValue(String defaultValue)

Description copied from interface: InputParam

Set default value of input parameter

Specified by:

setDefaultValue in interface InputParam

Parameters:

defaultValue - - default value of input parameter

getAllowedValuesWithDescriptions

public List<Pair<String,String>> getAllowedValuesWithDescriptions()

Description copied from interface: InputParam

Get allowed values and their descriptions of input parameter. Used for the case where parameter may only be one of a specific set of values.

Specified by:

getAllowedValuesWithDescriptions in interface InputParam

Returns:

allowed values and their descriptions of input parameter

setAllowedValuesWithDescriptions

public void setAllowedValuesWithDescriptions(List<Pair<String,String>> values)

Description copied from interface: InputParam

Set allowed values and their descriptions of input parameter

Specified by:

setAllowedValuesWithDescriptions in interface InputParam

Parameters:

values - - allowed values and their descriptions of input parameter

getLowBoundary

public String getLowBoundary()

Description copied from interface: InputParam

Get low boundary of input parameter, where boundary applies

Specified by:

getLowBoundary in interface InputParam

Returns:

low boundary of input parameter

setLowBoundary

public void setLowBoundary(String lowBoundary)

Description copied from interface: InputParam

Set low boundary of input parameter

Specified by:

setLowBoundary in interface InputParam

Parameters:

lowBoundary - - low boundary of input parameter

getHighBoundary

public String getHighBoundary()

Description copied from interface: InputParam

Get high boundary of input parameter, where boundary applies

Specified by:

getHighBoundary in interface InputParam

Returns:

high boundary of input parameter

setHighBoundary

public void setHighBoundary(String highBoundary)

Description copied from interface: InputParam

Set high boundary of input parameter

Specified by:

setHighBoundary in interface InputParam

Parameters:

highBoundary - - high boundary of input parameter

toString

public String toString()

Overrides:

toString in class Object