Package org.apache.openjpa.jdbc.meta
Class ValueMappingInfo
java.lang.Object
org.apache.openjpa.jdbc.meta.MappingInfo
org.apache.openjpa.jdbc.meta.ValueMappingInfo
- All Implemented Interfaces:
Serializable
Information about the mapping from a field value 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
- See Also:
-
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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Whether user has explicitly turned null indicator column off.protected void
clear
(boolean canFlags) Clear mapping information.void
copy
(MappingInfo info) Copy missing info from the instance to this one.int
findTargetField
(Column[] tmplates, String target) Return the position of the template column with the given target field.Column[]
getColumns
(ValueMapping val, String name, Column[] tmplates, Table table, boolean adapt) Deprecated.Column[]
getColumns
(ValueMapping val, DBIdentifier name, Column[] tmplates, Table table, boolean adapt) getIndex
(ValueMapping val, String name, boolean adapt) Deprecated.getIndex
(ValueMapping val, DBIdentifier name, boolean adapt) getInverseTypeJoin
(ValueMapping val, String name, boolean adapt) Deprecated.getInverseTypeJoin
(ValueMapping val, DBIdentifier name, boolean adapt) Raw column data.getNullIndicatorColumn
(ValueMapping val, String name, Table table, boolean adapt) Deprecated.getNullIndicatorColumn
(ValueMapping val, DBIdentifier name, Table table, boolean adapt) getTable
(ValueMapping val) getTypeJoin
(ValueMapping val, String name, boolean inversable, boolean adapt) Deprecated.getTypeJoin
(ValueMapping val, DBIdentifier name, boolean inversable, boolean adapt) getUnique
(ValueMapping val, String name, boolean adapt) Deprecated.getUnique
(ValueMapping val, DBIdentifier name, boolean adapt) boolean
Whether to use class criteria when joining to related type.void
setCanIndicateNull
(boolean ind) Whether user has explicitly turned null indicator column off.void
setMapsIdColumns
(List<Column> cols) Raw column data.void
setUseClassCriteria
(boolean criteria) Whether to use class criteria when joining to related type.void
syncWith
(ValueMapping val) Synchronize internal information with the mapping data for the given value.Methods inherited from class org.apache.openjpa.jdbc.meta.MappingInfo
assertNoForeignKey, assertNoIndex, assertNoJoin, assertNoSchemaComponents, assertNoUnique, assertStrategy, canForeignKey, canIndex, canUnique, clear, createColumns, createForeignKey, createIndex, createTable, createTable, createUnique, getColumnIO, getColumns, getColumns, getColumns, getForeignKey, getIndex, getJoinDirection, getStrategy, getUnique, hasSchemaComponents, isImplicitRelation, mergeColumn, setCanForeignKey, setCanIndex, setCanUnique, setColumnIO, setColumns, setForeignKey, setImplicitRelation, setIndex, setJoinDirection, setStrategy, setUnique, syncColumn, syncColumns, syncForeignKey, syncIndex, syncUnique
-
Constructor Details
-
ValueMappingInfo
public ValueMappingInfo()
-
-
Method Details
-
getUseClassCriteria
public boolean getUseClassCriteria()Whether to use class criteria when joining to related type. -
setUseClassCriteria
public void setUseClassCriteria(boolean criteria) Whether to use class criteria when joining to related type. -
canIndicateNull
public boolean canIndicateNull()Whether user has explicitly turned null indicator column off. -
setCanIndicateNull
public void setCanIndicateNull(boolean ind) Whether user has explicitly turned null indicator column off. -
getTypeJoin
@Deprecated public ForeignKey getTypeJoin(ValueMapping val, String name, boolean inversable, boolean adapt) Deprecated.Return the join from this value to its related type.- Parameters:
name
- base name for value mappinginversable
- whether an inverse join is allowed
-
getTypeJoin
public ForeignKey getTypeJoin(ValueMapping val, DBIdentifier name, boolean inversable, boolean adapt) -
getTable
-
getInverseTypeJoin
Deprecated.Return the join from the related type to this value. -
getInverseTypeJoin
-
getColumns
@Deprecated public Column[] getColumns(ValueMapping val, String name, Column[] tmplates, Table table, boolean adapt) Deprecated.Return the columns for this value, based on the given templates. -
getColumns
public Column[] getColumns(ValueMapping val, DBIdentifier name, Column[] tmplates, Table table, boolean adapt) -
findTargetField
Return the position of the template column with the given target field. -
getUnique
Deprecated.Return a unique constraint for the given columns, or null if none. -
getUnique
-
getIndex
Deprecated.Return an index for the given columns, or null if none. -
getIndex
-
getNullIndicatorColumn
@Deprecated public Column getNullIndicatorColumn(ValueMapping val, String name, Table table, boolean adapt) Deprecated.Return the null indicator column for this value, or null if none. -
getNullIndicatorColumn
public Column getNullIndicatorColumn(ValueMapping val, DBIdentifier name, Table table, boolean adapt) -
syncWith
Synchronize internal information with the mapping data for the given value. -
clear
protected void clear(boolean canFlags) Description copied from class:MappingInfo
Clear mapping information.- Overrides:
clear
in classMappingInfo
- Parameters:
canFlags
- whether to clear information about whether we can place indexed, foreign keys, etc on this mapping
-
copy
Description copied from class:MappingInfo
Copy missing info from the instance to this one.- Overrides:
copy
in classMappingInfo
-
getMapsIdColumns
Raw column data. -
setMapsIdColumns
Raw column data.
-