org.geotools.gc
Class ParameterInfo

java.lang.Object
  org.geotools.gc.ParameterInfo

All Implemented Interfaces:

java.io.Serializable

Deprecated. Replaced by ParameterDescriptor.

public class ParameterInfo

extends java.lang.Object

implements java.io.Serializable

Informations about a parameter required for a grid coverage processing operation. This information includes the name of the parameter, parameter description, parameter type etc. This is mostly a convenience class, since all informations are extracted from ParameterListDescriptor. We provide it because it is part of OpenGIS specification and its API is significantly different from Java Advanced Imaging.

Version:

$Id: ParameterInfo.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

OpenGIS, Martin Desruisseaux

See Also:

GC_ParameterInfo, Serialized Form

Constructor Summary

ParameterInfo(javax.media.jai.ParameterListDescriptor descriptor, int index)
Deprecated. Construct a new info for a parameter.

ParameterInfo(javax.media.jai.ParameterListDescriptor descriptor, java.lang.String name)
Deprecated. Construct a new info for a parameter.

Method Summary

boolean	equals(java.lang.Object object) Deprecated. Compares the specified object with this parameter for equality.
java.lang.Object	getDefaultValue() Deprecated. Returns the default value for parameter.
java.lang.String	getDescription(java.util.Locale locale) Deprecated. Returns the parameter description.
java.lang.Number	getMaximumValue() Deprecated. Returns the maximum parameter value.
java.lang.Number	getMinimumValue() Deprecated. Returns the minimum parameter value.
java.lang.String	getName() Deprecated. Returns the parameter name.
java.lang.Class	getType() Deprecated. Returns the parameter type.
int	hashCode() Deprecated. Returns a hash value for this parameter.
java.lang.String	toString() Deprecated. Returns a string repr?sentation of this parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterInfo

public ParameterInfo(javax.media.jai.ParameterListDescriptor descriptor,
                     java.lang.String name)
              throws java.lang.IllegalArgumentException

Deprecated.

Construct a new info for a parameter.

Parameters:

descriptor - The originating parameter list descriptor.

name - The parameter name.

Throws:

java.lang.IllegalArgumentException - if name is not a parameter of descriptor.

ParameterInfo

public ParameterInfo(javax.media.jai.ParameterListDescriptor descriptor,
                     int index)

Deprecated.

Construct a new info for a parameter.

Parameters:

descriptor - The originating parameter list descriptor.

index - The parameter index.

Method Detail

getName

public java.lang.String getName()

Deprecated.

Returns the parameter name.

See Also:

GC_ParameterInfo.getName()

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Deprecated.

Returns the parameter description. If no description is available, the value will be null. If a locale is supplied, this method will try to returns a description in this locale. The default implementation always returns null.

Parameters:

locale - The locale, or null for a default one.

Returns:

The description, or null if there is none.

See Also:

GC_ParameterInfo.getDescription()

getType

public java.lang.Class getType()

Deprecated.

Returns the parameter type.

See Also:

GC_ParameterInfo.getType()

getDefaultValue

public java.lang.Object getDefaultValue()

Deprecated.

Returns the default value for parameter. The type Object can be any type including a Number or a String. For example, a filtering operation could have a default kernel size of 3. If there is no default value, this method returns null.

See Also:

GC_ParameterInfo.getDefaultValue()

getMinimumValue

public java.lang.Number getMinimumValue()

Deprecated.

Returns the minimum parameter value. For example, a filtering operation could have a minimum kernel size of 3. If there is no minimum value, this method returns null.

See Also:

GC_ParameterInfo.getMinimumValue()

getMaximumValue

public java.lang.Number getMaximumValue()

Deprecated.

Returns the maximum parameter value. For example, a filtering operation could have a maximum kernel size of 9. If there is no maximum value, this method returns null.

See Also:

GC_ParameterInfo.getMaximumValue()

hashCode

public int hashCode()

Deprecated.

Returns a hash value for this parameter. This value need not remain consistent between different implementations of the same class.

equals

public boolean equals(java.lang.Object object)

Deprecated.

Compares the specified object with this parameter for equality.

toString

public java.lang.String toString()

Deprecated.

Returns a string repr?sentation of this parameter. The returned string is implementation dependent. It is usually provided for debugging purposes.