Package org.apache.openjpa.jdbc.meta

Class FieldMappingInfo

java.lang.Object
org.apache.openjpa.jdbc.meta.MappingInfo
org.apache.openjpa.jdbc.meta.FieldMappingInfo
All Implemented Interfaces:
Serializable, Commentable
public class FieldMappingInfo extends MappingInfo implements Commentable
Information about the mapping from a field to the schema, in raw form. The columns and tables used in mapping info will not be part of the SchemaGroup used at runtime. Rather, they will be structs with the relevant pieces of information filled in.
Author:
Abe White, Pinaki Poddar
See Also:

  • Constructor Details

    • FieldMappingInfo

      public FieldMappingInfo()

  • Method Details

    • getTableName

      @Deprecated public String getTableName()
      Deprecated.
      The user-supplied name of the table for this field.

    • getTableIdentifier

      public DBIdentifier getTableIdentifier()

    • setTableName

      @Deprecated public void setTableName(String tableName)
      Deprecated.
      The user-supplied name of the table for this field.

    • setTableIdentifier

      public void setTableIdentifier(DBIdentifier tableName)

    • isJoinOuter

      public boolean isJoinOuter()
      Whether the field's table is joined to the class table through an outer join.

    • setJoinOuter

      public void setJoinOuter(boolean outer)
      Whether the field's table is joined to the class table through an outer join.

    • getOrderColumn

      public Column getOrderColumn()
      Raw synthetic ordering column.

    • setOrderColumn

      public void setOrderColumn(Column order)
      Raw synthetic ordering column.

    • canOrderColumn

      public boolean canOrderColumn()
      Whether we can have an ordering column.

    • setCanOrderColumn

      public void setCanOrderColumn(boolean canOrder)
      Whether we can have an ordering column.

    • getTable

      public Table getTable(FieldMapping field, boolean create, boolean adapt)
      Return the table for the given field, or null if no table given.

    • getJoinForeignKey

      public ForeignKey getJoinForeignKey(FieldMapping field, Table table, boolean adapt)

    • getJoin

      public ForeignKey getJoin(FieldMapping field, Table table, boolean adapt)
      Return the join from the field table to the owning class table.

    • getJoin

      public ForeignKey getJoin(FieldMapping field, Table table, boolean adapt, List<Column> cols)

    • getJoinUnique

      public Unique getJoinUnique(FieldMapping field, boolean def, boolean adapt)
      Unique constraint on the field join.

    • addJoinTableUnique

      public void addJoinTableUnique(Unique u)
      Add Unique Constraint to the Join Table.

    • getJoinTableUniques

      public Unique[] getJoinTableUniques(FieldMapping field, boolean def, boolean adapt)
      Get the unique constraints associated with the Sequence table.

    • getJoinIndex

      public Index getJoinIndex(FieldMapping field, boolean adapt)
      Index on the field join.

    • getOrderColumn

      public Column getOrderColumn(FieldMapping field, Table table, boolean adapt)
      Return the ordering column for this field, or null if none.

    • syncWith

      public void syncWith(FieldMapping field)
      Synchronize internal information with the mapping data for the given field.

    • syncStrategy

      public void syncStrategy(FieldMapping field)
      Synchronize internal mapping strategy information with the given field.

    • syncOrderColumn

      public void syncOrderColumn(FieldMapping field)
      Synchronize internal order column information with the given field.

    • syncJoinTableUniques

      protected void syncJoinTableUniques(MetaDataContext context, Unique[] unqs)
      Sets internal constraint information to match given mapped constraint.

    • hasSchemaComponents

      public boolean hasSchemaComponents()
      Description copied from class: MappingInfo
      Return true if this info has columns, foreign key information, index information, etc.
      Overrides:
      hasSchemaComponents in class MappingInfo

    • clear

      protected void clear(boolean canFlags)
      Description copied from class: MappingInfo
      Clear mapping information.
      Overrides:
      clear in class MappingInfo
      Parameters:
      canFlags - whether to clear information about whether we can place indexed, foreign keys, etc on this mapping

    • copy

      public void copy(MappingInfo info)
      Description copied from class: MappingInfo
      Copy missing info from the instance to this one.
      Overrides:
      copy in class MappingInfo

    • getComments

      public String[] getComments()
      Description copied from interface: Commentable
      Return comments, or empty array if none.
      Specified by:
      getComments in interface Commentable

    • setComments

      public void setComments(String[] comments)
      Description copied from interface: Commentable
      Set comments.
      Specified by:
      setComments in interface Commentable