org.opengis.style.portrayal
Interface PortrayalOperation

Show UML class diagram

@UML(identifier="PF_PortrayalOperation",
     specification=ISO_19117)
public interface PortrayalOperation

A portrayal operation holds the details for a particular portrayal operation. It declares a set of formal parameters that are neeed when invoking the underlying rendering functions.

Ther should be one instance of portrayal specification class for each operation defined by the portrayal service.

Since:

GeoAPI 2.2

Method Summary

InternationalString	getDescription() Returns a description of the operation.
Collection<ExternalFunction>	getExternalFunctions() Returns the list of External functions.
Collection<AttributeDefinition>	getFormalParameters() Returns a list of attributDefinition used by this operation.
String	getName() Returns the name of the operation.
void	portray(ParameterSet parameters) Parameterset to use.

Method Detail

getName

@UML(identifier="name",
     obligation=MANDATORY,
     specification=ISO_19117)
String getName()

Returns the name of the operation.

Returns:

String

getDescription

@UML(identifier="description",
     obligation=OPTIONAL,
     specification=ISO_19117)
InternationalString getDescription()

Returns a description of the operation. It is a human readable value.

Returns:

InternationalString

getExternalFunctions

@UML(identifier="externalFunction",
     obligation=OPTIONAL,
     specification=ISO_19117)
Collection<ExternalFunction> getExternalFunctions()

Returns the list of External functions.

Returns:

Collection

getFormalParameters

@UML(identifier="formalParameter{ordered}",
     obligation=MANDATORY,
     specification=ISO_19117)
Collection<AttributeDefinition> getFormalParameters()

Returns a list of attributDefinition used by this operation.

Returns:

Collection

portray

void portray(ParameterSet parameters)

Parameterset to use. Those parameter are given when we invoke a portrayal operation, depending on the rendering device, this may result on a return value or not.

Caution This method may change !

Parameters:

parameters -