Class ImplHelper

java.lang.Object
org.apache.openjpa.util.ImplHelper

public class ImplHelper extends Object
Helper for OpenJPA back-ends.
Since:
0.3.0
Author:
Abe White
  • Constructor Details

    • ImplHelper

      public ImplHelper()
  • Method Details

    • loadAll

      public static Collection loadAll(Collection sms, StoreManager store, PCState state, int load, FetchConfiguration fetch, Object context)
      Helper for store manager implementations. This method simply delegates to the proper singular method for each state manager.
      Since:
      0.4.0
      See Also:
    • generateIdentityValue

      public static Object generateIdentityValue(StoreContext ctx, ClassMetaData meta, int typeCode)
      Generate a value for the given metadata, or return null. Generates values for hte following strategies: ValueStrategies.SEQUENCE, ValueStrategies.UUID_STRING, ValueStrategies.UUID_HEX
    • generateFieldValue

      public static Object generateFieldValue(StoreContext ctx, FieldMetaData fmd)
      Generate a value for the given metadata, or return null. Generates values for hte following strategies: ValueStrategies.SEQUENCE, ValueStrategies.UUID_STRING, ValueStrategies.UUID_HEX
    • getUpdateFields

      public static BitSet getUpdateFields(OpenJPAStateManager sm)
      Returns the fields of the state that require an update.
      Parameters:
      sm - the state to check
      Returns:
      the BitSet of fields that need update, or null if none
    • close

      public static void close(Object o)
      Close the given resource. The resource can be an extent iterator, query result, large result set relation, or any closeable OpenJPA component.
    • isManagedType

      public static boolean isManagedType(OpenJPAConfiguration conf, Class type)
      Returns true if the specified class is a type that can be managed by OpenJPA.
      Parameters:
      type - the class to test
      Returns:
      true if the class is manageable.
      Since:
      1.0.0
    • isManageable

      public static boolean isManageable(Object instance)
      Returns true if the specified instance is manageable.
      Parameters:
      instance - the object to check
      Returns:
      true if the instance is a persistent type, false otherwise
    • isAssignable

      public static boolean isAssignable(Class from, Class to)
      Returns true if the referenced "to" class is assignable to the "from" class. This helper method utilizes a cache to help avoid the overhead of the Class.isAssignableFrom() method.
      Parameters:
      from - target class instance to be checked for assignability
      to - second class instance to be checked for assignability
      Returns:
      true if the "to" class is assignable to the "from" class
    • toPersistenceCapable

      public static PersistenceCapable toPersistenceCapable(Object o, Object ctx)
      Returns:
      the persistence-capable instance responsible for managing o, or null if o is not manageable.
      Since:
      1.0.0
    • registerUnenhancedInstance

      public static void registerUnenhancedInstance(Object instance, PersistenceCapable pc)
      Registers the PersistenceCapable instance that manages the state of the given raw, unenhanced instance, so that subsequent calls to toPersistenceCapable(Object, Object) for that instance resolve to pc instead of creating a new ReflectingPersistenceCapable.

      Instances are keyed by identity rather than by Object.equals(Object), so value-based types such as records can be used as keys. Any mapping already present for the instance is replaced. pc is not required to report instance as its managed instance; for a record embeddable it is the embedded copy carrying the state manager.

      Parameters:
      instance - the raw, unenhanced managed instance
      pc - the persistence-capable instance to resolve it to
      Since:
      4.2.0
    • registerPersistenceCapable

      public static void registerPersistenceCapable(ReflectingPersistenceCapable pc)
      Re-registers a ReflectingPersistenceCapable against the instance it manages, for example after deserialization.
      Parameters:
      pc - the persistence-capable instance to register
      See Also:
    • getManagedInstance

      public static Object getManagedInstance(Object o)
      Returns:
      the user-visible representation of o.
      Since:
      1.0.0
    • getEntityClass

      public static Class<?> getEntityClass(Object obj)
      Returns the entity class for the given object, unwrapping any runtime-generated pcsubclass proxy. For runtime-enhanced entities, obj.getClass() returns the generated subclass (e.g. Order$pcsubclass), but for equals()/hashCode() comparisons the original entity class should be used. Generated subclass names are detected via PCEnhancer.isPCSubclassName(String), and superclasses are walked until a class that was not generated by the enhancer is reached, so nested generated subclasses are unwrapped as well.
      Parameters:
      obj - the object whose entity class to determine
      Returns:
      the original entity class (superclass of pcsubclass), or the object's actual class if it is not a pcsubclass
      Since:
      4.2.0