Module org.opengis.geoapi.example

Package org.opengis.example.parameter

Class SimpleParameterGroup

Object

SimpleIdentifiedObject

SimpleParameterGroup

All Implemented Interfaces:

Cloneable, Identifier, GeneralParameterDescriptor, GeneralParameterValue, ParameterDescriptorGroup, ParameterValueGroup, IdentifiedObject, ReferenceIdentifier

public class SimpleParameterGroup
extends SimpleIdentifiedObject
implements ParameterValueGroup, ParameterDescriptorGroup, Cloneable

A ParameterValueGroup implementation for SimpleParameter instances. In order to keep the conceptual model simpler, this parameter group is also its own descriptor. This is not quite a recommended practice (such descriptors are less suitable for use in HashMap), but allow us to keep the amount of classes smaller and closely related interfaces together.

The most interesting methods in this class are:

• SimpleIdentifiedObject.getName(), for the name of this parameter group
• parameter(String), for getting a parameter of the given name.

Since:

3.1

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<SimpleParameter>	parameters	The list of parameters included in this group.

Fields inherited from class SimpleIdentifiedObject

authority, code

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Fields inherited from interface Identifier

AUTHORITY_KEY, CODE_KEY, CODESPACE_KEY, DESCRIPTION_KEY, VERSION_KEY

Constructor Summary

Constructors

Constructor	Description
SimpleParameterGroup(Citation authority, String name, SimpleParameter... param)	Creates a new parameter group of the given authority and name.

Method Summary

Modifier and Type	Method	Description
ParameterValueGroup	addGroup(String name)	Creates a new group of the specified name.
SimpleParameterGroup	clone()	Returns a copy of this parameter group.
SimpleParameterGroup	createValue()	Returns a new group with the same authority, code and parameters than this group.
GeneralParameterDescriptor	descriptor(String name)	Returns the parameter descriptor in this group for the specified identifier code.
List<GeneralParameterDescriptor>	descriptors()	Returns the parameter descriptors in this group.
boolean	equals(Object object)	Compares the given object with this parameter group for equality.
InternationalString	getDescription()	Returns a natural language description of this object.
ParameterDescriptorGroup	getDescriptor()	Returns the descriptor of the parameter group.
List<ParameterValueGroup>	groups(String name)	Returns all subgroups with the specified name.
int	hashCode()	Returns a hash code value for this parameter group.
ParameterValue<?>	parameter(String name)	Returns the value in this group for the specified identifier code.
String	toString()	Returns a string representation of all parameters in this group.
List<GeneralParameterValue>	values()	Returns the parameter values in this group.

Methods inherited from class SimpleIdentifiedObject

getAuthority, getCode, getCodeSpace, getDomainOfValidity, getName, getScope, toWKT

Methods inherited from class Object

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

Methods inherited from interface GeneralParameterDescriptor

getDirection, getMaximumOccurs, getMinimumOccurs, getName

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getRemarks, toWKT

Methods inherited from interface Identifier

getVersion

Field Details

parameters

protected final List<SimpleParameter> parameters

The list of parameters included in this group. This simple group implementation supports only SimpleParameter instances, which are used both as parameter descriptor and parameter values for the double value type.

This list is live: changes to this list will be reflected immediately in the descriptors() and values() views.

Constructor Details

SimpleParameterGroup

public SimpleParameterGroup(Citation authority,
 String name,
 SimpleParameter... param)

Creates a new parameter group of the given authority and name.

Parameters:

authority - organization responsible for definition of the parameters, or null.

name - the parameter group name.

param - the parameters to be included in this group.

Method Details

getDescriptor

public ParameterDescriptorGroup getDescriptor()

Returns the descriptor of the parameter group. Since this simple class implements both the value and descriptor interfaces, this method returns this. However, more sophisticated libraries are likely to return a different object.

Specified by:

getDescriptor in interface GeneralParameterValue

Specified by:

getDescriptor in interface ParameterValueGroup

Returns:

this descriptor.

getDescription

public InternationalString getDescription()

Returns a natural language description of this object. The default implementation returns null.

Specified by:

getDescription in interface GeneralParameterDescriptor

Specified by:

getDescription in interface Identifier

Returns:

the natural language description, or null if none.

See Also:

• GeneralParameterDescriptor.getName()
• IdentifiedObject.getRemarks()

descriptors

public List<GeneralParameterDescriptor> descriptors()

Returns the parameter descriptors in this group. The list returned by this method is unmodifiable.

Implementation note: since the simple classes in this package implement both the value and the descriptor interfaces, this method returns the same list than the values() methods. However, more sophisticated libraries are likely to return a distinct list.

Specified by:

descriptors in interface ParameterDescriptorGroup

Returns:

the parameter descriptors in this group as an unmodifiable list.

values

public List<GeneralParameterValue> values()

Returns the parameter values in this group. The list returned by this method is unmodifiable.

Implementation note: since the simple classes in this package implement both the value and the descriptor interfaces, this method returns the same list than the descriptors() methods. However, more sophisticated libraries are likely to return a distinct list.

Specified by:

values in interface ParameterValueGroup

Returns:

the parameter values in this group as an unmodifiable list.

descriptor

public GeneralParameterDescriptor descriptor(String name)
                                      throws ParameterNotFoundException

Returns the parameter descriptor in this group for the specified identifier code.

Implementation note: since the simple classes in this package implement both the value and the descriptor interfaces, this method is synonymous to parameter(String). However, more sophisticated libraries are likely to return a distinct object.

Specified by:

descriptor in interface ParameterDescriptorGroup

Parameters:

name - the case insensitive identifier code of the parameter to search for.

Returns:

the parameter for the given identifier code.

Throws:

ParameterNotFoundException - if there is no parameter for the given identifier code.

parameter

public ParameterValue<?> parameter(String name)
                            throws ParameterNotFoundException

Returns the value in this group for the specified identifier code. This convenience method provides a way to get and set parameter values by name. For example, the following idiom fetches a floating point value for the "false_easting" parameter:

double value = parameter("false_easting").doubleValue();

The following idiom sets a floating point value for the "false_easting" parameter:

parameter("false_easting").setValue(500000.0);

Implementation note: since the simple classes in this package implement both the value and the descriptor interfaces, this method is essentially synonymous to descriptor(String). However, more sophisticated libraries are likely to return a distinct object.

Specified by:

parameter in interface ParameterValueGroup

Parameters:

name - the case insensitive identifier code of the parameter to search for.

Returns:

the parameter value for the given identifier code.

Throws:

ParameterNotFoundException - if there is no parameter value for the given identifier code.

groups

public List<ParameterValueGroup> groups(String name)
                                 throws ParameterNotFoundException

Returns all subgroups with the specified name. The default implementation always throws an exception, since this simple parameter group does not support subgroups.

Specified by:

groups in interface ParameterValueGroup

Parameters:

name - the case insensitive identifier code of the parameter group to search for.

Returns:

the set of all parameter group for the given identifier code.

Throws:

ParameterNotFoundException - if no descriptor was found for the given name.

addGroup

public ParameterValueGroup addGroup(String name)
                             throws ParameterNotFoundException

Creates a new group of the specified name. The default implementation always throws an exception, since this simple parameter group does not support subgroups.

Specified by:

addGroup in interface ParameterValueGroup

Parameters:

name - the case insensitive identifier code of the parameter group to create.

Returns:

a newly created parameter group for the given identifier code.

Throws:

ParameterNotFoundException - if no descriptor was found for the given name.

createValue

public SimpleParameterGroup createValue()

Returns a new group with the same authority, code and parameters than this group. The value of each parameter is left to their default value.

Implementation note: since this simple class implements both the value and the descriptor interfaces, this method is very similar to the clone() method. However, in more sophisticated libraries, the ParameterDescriptorGroup.createValue() and ParameterValueGroup.clone() methods are likely to be defined in different objects.

Specified by:

createValue in interface GeneralParameterDescriptor

Specified by:

createValue in interface ParameterDescriptorGroup

Returns:

a new parameter instance initialized to the default value.

See Also:

• clone()

clone

public SimpleParameterGroup clone()

Returns a copy of this parameter group. This method is similar to createValue() except for the following:

• This method returns an instance of the same class.
• The values() are initialized to the same values than the cloned group.

Specified by:

clone in interface GeneralParameterValue

Specified by:

clone in interface ParameterValueGroup

Overrides:

clone in class Object

Returns:

a copy of this group of parameter values.

See Also:

• createValue()

equals

public boolean equals(Object object)

Compares the given object with this parameter group for equality.

Overrides:

equals in class SimpleIdentifiedObject

Parameters:

object - the object to compare with this SimpleIdentifiedObject.

Returns:

true if the given object is equal to this object.

hashCode

public int hashCode()

Returns a hash code value for this parameter group.

Overrides:

hashCode in class SimpleIdentifiedObject

toString

public String toString()

Returns a string representation of all parameters in this group.

Overrides:

toString in class SimpleIdentifiedObject