OpenJPA
  1. OpenJPA
  2. OPENJPA-2047

Document the impact of Persistence Aware classes

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.2.2, 2.1.1
    • Fix Version/s: 2.2.0
    • Component/s: docs
    • Labels:
      None

      Description

      The PCEnhancer makes non entity classes "persistence aware", but we never explain what that means in the manual.

      The answer can be found in the JDO specification, but we should document it in our manual as well. Many users may not be familiar with JDO or OpenJPA's JDO background. To those users the warning message issued by the PCEnhancer can be confusing, or a cause for alarm.

      As a first pass we should add this information to the users manual. It would also be good to improve the logging of the PCEnhancer. In most cases the warning message is harmless, and should be treated as an INFO message (or better yet, we can issue a single message that lists all the persistence aware classes).

      1. OPENJPA-2027.patch
        3 kB
        Jacob Nowosatka

        Activity

        Hide
        Albert Lee added a comment -

        Close issue in preparation for 2.2.0 release.

        Show
        Albert Lee added a comment - Close issue in preparation for 2.2.0 release.
        Hide
        Rick Curtis added a comment -

        The existing documentation will suffice for me. Thanks for the patch!

        Show
        Rick Curtis added a comment - The existing documentation will suffice for me. Thanks for the patch!
        Hide
        Jacob Nowosatka added a comment -

        Rick,

        No, I do not have any updates to the docs. As I mentioned in my first comment, persistence-aware classes are already described in the documentation. If description is unsatisfactory, let me know and I will update it.

        Thanks,
        Jake

        Show
        Jacob Nowosatka added a comment - Rick, No, I do not have any updates to the docs. As I mentioned in my first comment, persistence-aware classes are already described in the documentation. If description is unsatisfactory, let me know and I will update it. Thanks, Jake
        Hide
        Rick Curtis added a comment -

        Committed a slightly modified version of Jacobs patch to trunk with revision 1207647. Please let me know if I changed the intent of this JIRA.

        Jacob – any chance you have any doc updates for this JIRA?

        Thanks,
        Rick

        Show
        Rick Curtis added a comment - Committed a slightly modified version of Jacobs patch to trunk with revision 1207647. Please let me know if I changed the intent of this JIRA. Jacob – any chance you have any doc updates for this JIRA? Thanks, Rick
        Hide
        Jacob Nowosatka added a comment -

        This patch removes the "WARN" message in favor of a single "INFO" message that lists all the persistence-aware classes.

        Persistence-aware classes are actually described in the documentation (Chapter 5: Persistence Classes, Section 2.1: Enhancing at build time) - "You can also run it over classes that are not persistence-capable, in which case it will treat the class as persistence-aware. Persistence-aware classes can directly manipulate the persistent fields of persistence-capable classes."

        Show
        Jacob Nowosatka added a comment - This patch removes the "WARN" message in favor of a single "INFO" message that lists all the persistence-aware classes. Persistence-aware classes are actually described in the documentation (Chapter 5: Persistence Classes, Section 2.1: Enhancing at build time) - "You can also run it over classes that are not persistence-capable, in which case it will treat the class as persistence-aware. Persistence-aware classes can directly manipulate the persistent fields of persistence-capable classes."

          People

          • Assignee:
            Jacob Nowosatka
            Reporter:
            Michael Dick
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development