|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.openjpa.jdbc.meta.MappingInfo
org.apache.openjpa.jdbc.meta.ClassMappingInfo
public class ClassMappingInfo
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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.openjpa.jdbc.meta.MappingInfo |
---|
MappingInfo.ForeignKeyDefaults, MappingInfo.TableDefaults |
Field Summary |
---|
Fields inherited from class org.apache.openjpa.jdbc.meta.MappingInfo |
---|
JOIN_FORWARD, JOIN_INVERSE, JOIN_NONE |
Fields inherited from interface org.apache.openjpa.lib.meta.SourceTracker |
---|
SRC_ANNOTATIONS, SRC_OTHER, SRC_XML |
Fields inherited from interface org.apache.openjpa.lib.xml.Commentable |
---|
EMPTY_COMMENTS |
Constructor Summary | |
---|---|
ClassMappingInfo()
|
Method Summary | |
---|---|
void |
addSecondaryTable(String second)
Adds a Secondary table of given name to this mapping. |
void |
addUnique(String table,
Unique unique)
Add a unique constraint for the given table. |
protected void |
clear(boolean canFlags)
Clear mapping information. |
void |
copy(MappingInfo info)
Copy missing info from the instance to this one. |
String |
getClassName()
The described class name. |
int |
getColNumber()
|
String[] |
getComments()
|
Column[] |
getDataStoreIdColumns(ClassMapping cls,
Column[] tmplates,
Table table,
boolean adapt)
Return the datastore identity columns for the given class, based on the given templates. |
String |
getHierarchyStrategy()
The default strategy for subclasses in this hierarchy. |
int |
getLineNumber()
|
String |
getResourceName()
|
String |
getSchemaName()
The default schema name for unqualified tables. |
List |
getSecondaryTableJoinColumns(String tableName)
Return any columns defined for the given class level join, or empty list if none. |
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. |
String[] |
getSecondaryTableNames()
Return the class-level joined tables. |
File |
getSourceFile()
|
Object |
getSourceScope()
|
int |
getSourceType()
|
ForeignKey |
getSuperclassJoin(ClassMapping cls,
Table table,
boolean adapt)
Return the join from this class to its superclass. |
Table |
getTable(ClassMapping cls,
boolean adapt)
Return the primary table for the given class. |
Table |
getTable(ClassMapping cls,
String tableName,
boolean adapt)
Return the named table for the given class. |
String |
getTableName()
The given table name. |
Unique[] |
getUniques(MetaDataContext cm,
boolean adapt)
Get all the unique constraints associated with both the primary and/or secondary tables. |
Unique[] |
getUniques(String table)
Get the unique constraints of the given primary or secondary table. |
boolean |
hasSchemaComponents()
Return true if this info has columns, foreign key information, index information, etc. |
boolean |
isJoinedSubclass()
Whether there is a join to the superclass table. |
void |
setClassName(String name)
The described class name. |
void |
setColNumber(int colNum)
|
void |
setComments(String[] comments)
|
void |
setHierarchyStrategy(String strategy)
The default strategy for subclasses in this hierarchy. |
void |
setJoinedSubclass(boolean joined)
Whether there is a join to the superclass table. |
void |
setLineNumber(int lineNum)
|
void |
setSchemaName(String schema)
The default schema name for unqualified tables. |
void |
setSecondaryTableJoinColumns(String tableName,
List cols)
Declare the given class-level join to the named (secondary) table. |
void |
setSource(File file,
int srcType)
|
void |
setTableName(String table)
The given table name. |
void |
syncWith(ClassMapping cls)
Synchronize internal information with the mapping data for the given class. |
Methods inherited from class org.apache.openjpa.jdbc.meta.MappingInfo |
---|
assertNoForeignKey, assertNoIndex, assertNoJoin, assertNoSchemaComponents, assertNoUnique, assertStrategy, canForeignKey, canIndex, canUnique, clear, createColumns, createForeignKey, createIndex, createTable, createUnique, getColumnIO, getColumns, getForeignKey, getIndex, getJoinDirection, getStrategy, getUnique, mergeColumn, setCanForeignKey, setCanIndex, setCanUnique, setColumnIO, setColumns, setForeignKey, setIndex, setJoinDirection, setStrategy, setUnique, syncColumn, syncColumns, syncForeignKey, syncIndex, syncUnique |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ClassMappingInfo()
Method Detail |
---|
public String getClassName()
public void setClassName(String name)
public String getHierarchyStrategy()
public void setHierarchyStrategy(String strategy)
public String getTableName()
public void setTableName(String table)
public String getSchemaName()
public void setSchemaName(String schema)
public boolean isJoinedSubclass()
public void setJoinedSubclass(boolean joined)
public String[] getSecondaryTableNames()
public String getSecondaryTableName(String tableName)
public List getSecondaryTableJoinColumns(String tableName)
public void addSecondaryTable(String second)
public void setSecondaryTableJoinColumns(String tableName, List cols)
public Table getTable(ClassMapping cls, String tableName, boolean adapt)
public Table getTable(ClassMapping cls, boolean adapt)
public Column[] getDataStoreIdColumns(ClassMapping cls, Column[] tmplates, Table table, boolean adapt)
public ForeignKey getSuperclassJoin(ClassMapping cls, Table table, boolean adapt)
public void syncWith(ClassMapping cls)
public boolean hasSchemaComponents()
MappingInfo
hasSchemaComponents
in class MappingInfo
protected void clear(boolean canFlags)
MappingInfo
clear
in class MappingInfo
canFlags
- whether to clear information about whether we
can place indexed, foreign keys, etc on this mappingpublic void copy(MappingInfo info)
MappingInfo
copy
in class MappingInfo
public void addUnique(String table, Unique unique)
table
- must be primary table or secondary table name added a
priori to this receiver.unique
- the unique constraint. null means no-op.public Unique[] getUniques(String table)
public Unique[] getUniques(MetaDataContext cm, boolean adapt)
public File getSourceFile()
getSourceFile
in interface org.apache.openjpa.lib.meta.SourceTracker
public Object getSourceScope()
getSourceScope
in interface org.apache.openjpa.lib.meta.SourceTracker
public int getSourceType()
getSourceType
in interface org.apache.openjpa.lib.meta.SourceTracker
public void setSource(File file, int srcType)
public String getResourceName()
getResourceName
in interface org.apache.openjpa.lib.meta.SourceTracker
public String[] getComments()
getComments
in interface org.apache.openjpa.lib.xml.Commentable
public void setComments(String[] comments)
setComments
in interface org.apache.openjpa.lib.xml.Commentable
public int getLineNumber()
getLineNumber
in interface org.apache.openjpa.lib.meta.SourceTracker
public void setLineNumber(int lineNum)
public int getColNumber()
getColNumber
in interface org.apache.openjpa.lib.meta.SourceTracker
public void setColNumber(int colNum)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |