Class JDOAnnotationUtils

java.lang.Object
org.datanucleus.api.jdo.metadata.JDOAnnotationUtils
public class JDOAnnotationUtils extends Object
Series of utility methods for converting between annotations and metadata.

  • Field Details

    • PERSISTENCE_CAPABLE

      public static final String PERSISTENCE_CAPABLE

    • PERSISTENCE_AWARE

      public static final String PERSISTENCE_AWARE

    • EMBEDDED_ONLY

      public static final String EMBEDDED_ONLY

    • VERSION

      public static final String VERSION

    • DATASTORE_IDENTITY

      public static final String DATASTORE_IDENTITY

    • PRIMARY_KEY

      public static final String PRIMARY_KEY

    • JOINS

      public static final String JOINS

    • JOIN

      public static final String JOIN

    • INHERITANCE

      public static final String INHERITANCE

    • DISCRIMINATOR

      public static final String DISCRIMINATOR

    • QUERIES

      public static final String QUERIES

    • QUERY

      public static final String QUERY

    • FETCHPLAN

      public static final String FETCHPLAN

    • FETCHPLANS

      public static final String FETCHPLANS

    • FETCHGROUPS

      public static final String FETCHGROUPS

    • FETCHGROUP

      public static final String FETCHGROUP

    • SEQUENCE

      public static final String SEQUENCE

    • INDICES

      public static final String INDICES

    • INDEX

      public static final String INDEX

    • UNIQUES

      public static final String UNIQUES

    • UNIQUE

      public static final String UNIQUE

    • FOREIGNKEYS

      public static final String FOREIGNKEYS

    • FOREIGNKEY

      public static final String FOREIGNKEY

    • COLUMNS

      public static final String COLUMNS

    • COLUMN

      public static final String COLUMN

    • EXTENSIONS

      public static final String EXTENSIONS

    • EXTENSION

      public static final String EXTENSION

    • PERSISTENT

      public static final String PERSISTENT

    • TRANSACTIONAL

      public static final String TRANSACTIONAL

    • NOTPERSISTENT

      public static final String NOTPERSISTENT

    • SERIALIZED

      public static final String SERIALIZED

    • ELEMENT

      public static final String ELEMENT

    • KEY

      public static final String KEY

    • VALUE

      public static final String VALUE

    • ORDER

      public static final String ORDER

    • EMBEDDED

      public static final String EMBEDDED

    • CACHEABLE

      public static final String CACHEABLE

    • CONVERT

      public static final String CONVERT

    • PRESTORE

      public static final String PRESTORE
      See Also:

    • PREDELETE

      public static final String PREDELETE
      See Also:

    • PREATTACH

      public static final String PREATTACH
      See Also:

    • POSTATTACH

      public static final String POSTATTACH
      See Also:

    • PRECLEAR

      public static final String PRECLEAR
      See Also:

    • PREDETACH

      public static final String PREDETACH
      See Also:

    • POSTDETACH

      public static final String POSTDETACH
      See Also:

    • POSTLOAD

      public static final String POSTLOAD
      See Also:

  • Constructor Details

    • JDOAnnotationUtils

      public JDOAnnotationUtils()

  • Method Details

    • getQueryLanguageName

      public static String getQueryLanguageName(String value)
      Convenience accessor for the query language to a valid internal value.
      Parameters:
      value - The query language name
      Returns:
      The internal name

    • getNullValueString

      public static String getNullValueString(javax.jdo.annotations.NullValue value)
      Convenience accessor for the string name of a null value action.
      Parameters:
      value - The annotation null value
      Returns:
      The name

    • getForeignKeyActionString

      public static String getForeignKeyActionString(javax.jdo.annotations.ForeignKeyAction action)
      Convenience accessor for the string name of a FK action.
      Parameters:
      action - The annotation action
      Returns:
      The name

    • getFieldPersistenceModifier

      public static org.datanucleus.metadata.FieldPersistenceModifier getFieldPersistenceModifier(javax.jdo.annotations.PersistenceModifier modifier)
      Convenience accessor for the persistence-modifier on a field.
      Parameters:
      modifier - The annotation modifier
      Returns:
      The modifier

    • getIdentityTypeString

      public static String getIdentityTypeString(javax.jdo.annotations.IdentityType idType)
      Convenience accessor for the string name of the identity type.
      Parameters:
      idType - The id type
      Returns:
      The name

    • getSequenceStrategyString

      public static String getSequenceStrategyString(javax.jdo.annotations.SequenceStrategy strategy)
      Convenience accessor for the string name of a datastore sequence strategy.
      Parameters:
      strategy - The annotation strategy
      Returns:
      The name

    • getValueGenerationStrategyString

      public static String getValueGenerationStrategyString(javax.jdo.annotations.IdGeneratorStrategy strategy)
      Convenience accessor for the string name of a id generator strategy (from JDO annotations).
      Parameters:
      strategy - The id generation strategy
      Returns:
      The name

    • getVersionStrategyString

      public static String getVersionStrategyString(javax.jdo.annotations.VersionStrategy strategy)
      Convenience accessor for the string name of a version strategy.
      Parameters:
      strategy - The version strategy
      Returns:
      The name

    • getInheritanceStrategyString

      public static String getInheritanceStrategyString(javax.jdo.annotations.InheritanceStrategy strategy)
      Convenience accessor for the string name of an inheritance strategy.
      Parameters:
      strategy - The inheritance strategy
      Returns:
      The name

    • getDiscriminatorStrategyString

      public static String getDiscriminatorStrategyString(javax.jdo.annotations.DiscriminatorStrategy strategy)
      Convenience accessor for the string name of a discriminator strategy.
      Parameters:
      strategy - The discriminator strategy
      Returns:
      The name

    • getColumnMetaDataForAnnotations

      public static org.datanucleus.metadata.ColumnMetaData getColumnMetaDataForAnnotations(Map<String,Object> annotationValues)
      Convenience method to get the column metadata for annotation values of a @Column.
      Parameters:
      annotationValues - The values for the annotation
      Returns:
      The MetaData for the column

    • getColumnMetaDataForColumnAnnotation

      public static org.datanucleus.metadata.ColumnMetaData getColumnMetaDataForColumnAnnotation(javax.jdo.annotations.Column col)
      Convenience method to get the column metadata for a Column annotation.
      Parameters:
      col - The Column annotation
      Returns:
      The MetaData for the column

    • getIndexMetaData

      public static org.datanucleus.metadata.IndexMetaData getIndexMetaData(String name, String table, String unique, String[] fields, javax.jdo.annotations.Column[] columns)
      Convenience method to create an IndexMetaData from the annotations data.
      Parameters:
      name - Name of the constraint
      table - Name of the table (optional)
      unique - Whether the constraint is unique
      fields - Fields to apply the constraint across (optional)
      columns - Columns to apply the constraint across (optional)
      Returns:
      The IndexMetaData

    • getUniqueMetaData

      public static org.datanucleus.metadata.UniqueMetaData getUniqueMetaData(String name, String table, String deferred, String[] fields, javax.jdo.annotations.Column[] columns)
      Convenience method to create a UniqueMetaData from the annotations data.
      Parameters:
      name - Name of the constraint
      table - Name of the table (optional)
      deferred - Whether the constraint is deferred
      fields - Fields to apply the constraint across (optional)
      columns - Columns to apply the constraint across (optional)
      Returns:
      The UniqueMetaData

    • getFKMetaData

      public static org.datanucleus.metadata.ForeignKeyMetaData getFKMetaData(String name, String table, String unique, String deferred, String deleteAction, String updateAction, String[] fields, javax.jdo.annotations.Column[] columns)
      Convenience method to create a ForeignKeyMetaData from the annotations data.
      Parameters:
      name - Name of the constraint
      table - Name of the table (optional)
      unique - Whether the constraint is unique
      deferred - Whether the constraint is deferred
      deleteAction - Any delete action
      updateAction - Any update action
      fields - Fields to apply the constraint across (optional)
      columns - Columns to apply the constraint across (optional)
      Returns:
      The ForeignKeyMetaData

    • addExtensionsToMetaData

      public static void addExtensionsToMetaData(org.datanucleus.metadata.MetaData metadata, javax.jdo.annotations.Extension[] extensions)
      Convenience method to add extensions to a metadata element.
      Parameters:
      metadata - The metadata element
      extensions - The extension annotations