Annotation Type FetchPlan


  • @Target(TYPE)
    @Retention(RUNTIME)
    @Repeatable(FetchPlans.class)
    public @interface FetchPlan
    Annotation for the fetch plan of a persistence manager, query, or extent. Corresponds to the xml element "fetch-plan".
    Since:
    2.1
    Version:
    2.1
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String[] fetchGroups
      The fetch groups in this fetch plan.
      int fetchSize
      The number of instances of multi-valued fields retrieved by queries.
      int maxFetchDepth
      The depth of references to instantiate, starting with the root object.
      java.lang.String name
      Name of the fetch plan.
    • Element Detail

      • name

        java.lang.String name
        Name of the fetch plan.
        Returns:
        the name of the fetch plan
        Default:
        ""
      • fetchGroups

        java.lang.String[] fetchGroups
        The fetch groups in this fetch plan.
        Returns:
        the fetch groups
        Default:
        {}
      • maxFetchDepth

        int maxFetchDepth
        The depth of references to instantiate, starting with the root object.
        Returns:
        the maxium fetch depth
        Default:
        1
      • fetchSize

        int fetchSize
        The number of instances of multi-valued fields retrieved by queries.
        Returns:
        the fetch size
        Default:
        0