com.supermap.services.components

Annotation Type Component


  • @Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface Component

    Service component comments.

    The service provider type () that used to annotation service components, and the type of service provider in settings must be Java interfaces, does not support the normal class. For example, setting providerTypes = {MapProvider class} means the map service provider that the current service components need to use .

    Sets the service provider type's optional attribute by setting # optional () optional, such as providerTypes = {Provider1.class, Provider2.class}, and when optional = true, you can use any type's service provider in Provider1 and Provider2 ; when optional = false , the both type's service provider must be used. The default value is false.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element and Description
      java.lang.String type
      Service component type.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      java.lang.Class<? extends DigestMapping> digestMapping
      Service summary information mapping object.
      java.lang.Class<? extends NameMapping> nameMapping
      Name mapping object.
      boolean optional
      Service provider type's optional attribute
      java.lang.Class[] providerTypes
      Service provider type.

    • Element Detail

      • type

        public abstract java.lang.String type

        Service component type.

        Identify the types of the service components. The types of existing component modules are: Data, Map, TransportationAnalyst, Realspace, SpatialAnalyst.

        Returns:
        The service component type represented by String.

      • providerTypes

        public abstract java.lang.Class[] providerTypes

        Service provider type.

        The service provider type that used to setting service components, must be a Java interface, does not support normal class. The default value is Class empty array.

        Returns:
        Service provider type lists.
        Default:
        {}

      • optional

        public abstract boolean optional

        Service provider type's optional attribute

        True means selectable, false means non-selectable(Each service provider is essential). For example, setting providerTypes={Provider1.class,Provider2.class}, when optional =true,any one 's service provider of Provider1 and Provider2 can be used, when optional = false , the both type's service provider must be used.

        The default value is false.

        Returns:
        Service provider type's optional attribute. ture means optional, false means no option.
        Default:
        false

      • nameMapping

        public abstract java.lang.Class<? extends NameMapping> nameMapping

        Name mapping object.

        The name mapping object can gain the corresponding name (such as map name, data source name, scene name, etc.) in the business component, which is mainly used in the cluster to distinguish the homogeneous object.

        Default:
        com.supermap.services.components.DefaultNameMapping.class

      • digestMapping

        public abstract java.lang.Class<? extends DigestMapping> digestMapping

        Service summary information mapping object.

        Returns:
        Since:
        6.1.3
        Default:
        com.supermap.services.components.DefaultDigestMapping.class