Interface PortrayalOperation


  • @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.

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

    Since:
    GeoAPI 2.2
    • Method Detail

      • getName

        @UML(identifier="name",
             obligation=MANDATORY,
             specification=ISO_19117)
        String getName()
        Returns the name of the operation.
      • getDescription

        @UML(identifier="description",
             obligation=OPTIONAL,
             specification=ISO_19117)
        InternationalString getDescription()
        Returns a description of the operation. It is a human readable value.
      • getExternalFunctions

        @UML(identifier="externalFunction",
             obligation=OPTIONAL,
             specification=ISO_19117)
        Collection<ExternalFunction> getExternalFunctions()
        Returns the list of External functions.
      • getFormalParameters

        @UML(identifier="formalParameter{ordered}",
             obligation=MANDATORY,
             specification=ISO_19117)
        Collection<AttributeDefinition> getFormalParameters()
        Returns a list of attributDefinition used by this operation.
      • 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!