Save This Page
Home » apache-openjpa-1.1.0-source » org.apache.openjpa.jdbc » meta » [javadoc | source]
org.apache.openjpa.jdbc.meta
public class: ClassMappingInfo [javadoc | source]
java.lang.Object
   org.apache.openjpa.jdbc.meta.MappingInfo
      org.apache.openjpa.jdbc.meta.ClassMappingInfo

All Implemented Interfaces:
    Commentable, SourceTracker, Serializable

Information about the mapping from a class 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.
Fields inherited from org.apache.openjpa.jdbc.meta.MappingInfo:
JOIN_NONE,  JOIN_FORWARD,  JOIN_INVERSE
Method from org.apache.openjpa.jdbc.meta.ClassMappingInfo Summary:
addUnique,   clear,   copy,   getClassName,   getComments,   getDataStoreIdColumns,   getHierarchyStrategy,   getResourceName,   getSchemaName,   getSecondaryTableJoinColumns,   getSecondaryTableName,   getSecondaryTableNames,   getSourceFile,   getSourceScope,   getSourceType,   getSuperclassJoin,   getTable,   getTableName,   getUniques,   getUniques,   hasSchemaComponents,   isJoinedSubclass,   setClassName,   setComments,   setHierarchyStrategy,   setJoinedSubclass,   setSchemaName,   setSecondaryTableJoinColumns,   setSource,   setTableName,   syncWith
Methods from org.apache.openjpa.jdbc.meta.MappingInfo:
assertNoForeignKey,   assertNoIndex,   assertNoJoin,   assertNoSchemaComponents,   assertNoUnique,   assertStrategy,   canForeignKey,   canIndex,   canUnique,   clear,   clear,   copy,   createColumns,   createForeignKey,   createIndex,   createTable,   createUnique,   getColumnIO,   getColumns,   getForeignKey,   getIndex,   getJoinDirection,   getStrategy,   getUnique,   hasSchemaComponents,   mergeColumn,   setCanForeignKey,   setCanIndex,   setCanUnique,   setColumnIO,   setColumns,   setForeignKey,   setIndex,   setJoinDirection,   setStrategy,   setUnique,   syncColumn,   syncColumns,   syncForeignKey,   syncIndex,   syncUnique
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.openjpa.jdbc.meta.ClassMappingInfo Detail:
 public  void addUnique(Unique unique) 
 protected  void clear(boolean canFlags) 
 public  void copy(MappingInfo info) 
 public String getClassName() 
    The described class name.
 public String[] getComments() 
 public Column[] getDataStoreIdColumns(ClassMapping cls,
    Column[] tmplates,
    Table table,
    boolean adapt) 
    Return the datastore identity columns for the given class, based on the given templates.
 public String getHierarchyStrategy() 
    The default strategy for subclasses in this hierarchy.
 public String getResourceName() 
 public String getSchemaName() 
    The default schema name for unqualified tables.
 public List getSecondaryTableJoinColumns(String tableName) 
    Return any columns defined for the given class level join, or empty list if none.
 public String getSecondaryTableName(String tableName) 
    We allow fields to reference class-level joins using just the table name, whereas the class join might have schema, etc information. This method returns the name of the given table as listed in a class-level join, or the given name if no join exists.
 public String[] getSecondaryTableNames() 
    Return the class-level joined tables.
 public File getSourceFile() 
 public Object getSourceScope() 
 public int getSourceType() 
 public ForeignKey getSuperclassJoin(ClassMapping cls,
    Table table,
    boolean adapt) 
    Return the join from this class to its superclass. The table for this class must be set.
 public Table getTable(ClassMapping cls,
    boolean adapt) 
    Return the table for the given class.
 public String getTableName() 
    The given table name.
 public Unique[] getUniques() 
 public Unique[] getUniques(ClassMapping cm,
    boolean adapt) 
 public boolean hasSchemaComponents() 
 public boolean isJoinedSubclass() 
    Whether there is a join to the superclass table.
 public  void setClassName(String name) 
    The described class name.
 public  void setComments(String[] comments) 
 public  void setHierarchyStrategy(String strategy) 
    The default strategy for subclasses in this hierarchy.
 public  void setJoinedSubclass(boolean joined) 
    Whether there is a join to the superclass table.
 public  void setSchemaName(String schema) 
    The default schema name for unqualified tables.
 public  void setSecondaryTableJoinColumns(String tableName,
    List cols) 
    Declare the given class-level join.
 public  void setSource(File file,
    int srcType) 
 public  void setTableName(String table) 
    The given table name.
 public  void syncWith(ClassMapping cls) 
    Synchronize internal information with the mapping data for the given class.