Package org.datanucleus.metadata
Class ColumnMetaData
- java.lang.Object
-
- org.datanucleus.metadata.MetaData
-
- org.datanucleus.metadata.ColumnMetaData
-
- All Implemented Interfaces:
java.io.Serializable
public class ColumnMetaData extends MetaData
Representation of the Meta-Data for a column mapping of a field.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.Boolean
allowsNull
Whether the column accepts nulls.protected java.lang.String
columnDdl
Optional column DDL appended to the column definition defined by DataNucleus.protected java.lang.String
defaultValue
Default value for the column (when constructing the table with this column).protected boolean
insertable
Whether this column is to be inserted when the owning object is inserted.protected java.lang.String
insertValue
value to use when inserting this column in the datastore (the column is not mapped to a field/property)protected JdbcType
jdbcType
jdbc-type to use (if any).protected java.lang.Integer
length
length to use (if any).protected java.lang.String
name
column name.protected java.lang.Integer
position
Column position for the table as a whole (0-origin).protected java.lang.Integer
scale
scale to use (if any).private static long
serialVersionUID
protected java.lang.String
sqlType
sql-type to use (if any).protected java.lang.String
target
target column name (for matching across a FK).protected java.lang.String
targetMember
target field/property name (for matching across a FK).protected boolean
unique
Whether this column should be marked as UNIQUE.protected boolean
updateable
Whether this column can be updated when the owning object is updated.-
Fields inherited from class org.datanucleus.metadata.MetaData
EXTENSION_CLASS_CREATETIMESTAMP, EXTENSION_CLASS_CREATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_CREATEUSER, EXTENSION_CLASS_CREATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_CREATEUSER_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH, EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE, EXTENSION_CLASS_MULTITENANT, EXTENSION_CLASS_READ_ONLY, EXTENSION_CLASS_SOFTDELETE, EXTENSION_CLASS_SOFTDELETE_COLUMN_NAME, EXTENSION_CLASS_UPDATETIMESTAMP, EXTENSION_CLASS_UPDATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_UPDATEUSER, EXTENSION_CLASS_UPDATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_UPDATEUSER_COLUMN_NAME, EXTENSION_CLASS_VERSION_FIELD_NAME, EXTENSION_CLASS_VIEW_DEFINITION, EXTENSION_CLASS_VIEW_IMPORTS, EXTENSION_INDEX_COLUMN_ORDERING, EXTENSION_MEMBER_CACHEABLE, EXTENSION_MEMBER_CALENDAR_ONE_COLUMN, EXTENSION_MEMBER_CASCADE_ATTACH, EXTENSION_MEMBER_CASCADE_DETACH, EXTENSION_MEMBER_CASCADE_PERSIST, EXTENSION_MEMBER_CASCADE_REFRESH, EXTENSION_MEMBER_COMPARATOR_NAME, EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS, EXTENSION_MEMBER_CREATE_TIMESTAMP, EXTENSION_MEMBER_CREATE_USER, EXTENSION_MEMBER_ENUM_VALUE_GETTER, EXTENSION_MEMBER_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_INSERTABLE, EXTENSION_MEMBER_KEY_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_LIST_ORDERING, EXTENSION_MEMBER_RELATION_DISCRIM_COLUMN, EXTENSION_MEMBER_RELATION_DISCRIM_PK, EXTENSION_MEMBER_RELATION_DISCRIM_VALUE, EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL, EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED, EXTENSION_MEMBER_TYPE_CONVERTER_NAME, EXTENSION_MEMBER_UPDATE_TIMESTAMP, EXTENSION_MEMBER_UPDATE_USER, EXTENSION_MEMBER_UPDATEABLE, EXTENSION_MEMBER_VALUE_IMPLEMENTATION_CLASSES, EXTENSION_VERSION_NUMBER_INITIAL_VALUE, extensions, metaDataState, parent, VENDOR_NAME
-
-
Constructor Summary
Constructors Constructor Description ColumnMetaData()
Default constructor.ColumnMetaData(ColumnMetaData colmd)
Creates a ColumnMetaData by copying contents fromcolmd
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Boolean
getAllowsNull()
java.lang.String
getColumnDdl()
java.lang.String
getDefaultValue()
boolean
getInsertable()
java.lang.String
getInsertValue()
JdbcType
getJdbcType()
java.lang.String
getJdbcTypeName()
java.lang.Integer
getLength()
java.lang.String
getName()
java.lang.Integer
getPosition()
java.lang.Integer
getScale()
java.lang.String
getSqlType()
java.lang.String
getTarget()
java.lang.String
getTargetMember()
boolean
getUnique()
boolean
getUpdateable()
boolean
isAllowsNull()
ColumnMetaData
setAllowsNull(java.lang.Boolean allowsNull)
ColumnMetaData
setAllowsNull(java.lang.String allowsNull)
void
setColumnDdl(java.lang.String columnDdl)
ColumnMetaData
setDefaultValue(java.lang.String defaultValue)
ColumnMetaData
setInsertable(boolean insertable)
ColumnMetaData
setInsertable(java.lang.String insertable)
ColumnMetaData
setInsertValue(java.lang.String insertValue)
ColumnMetaData
setJdbcType(java.lang.String jdbcTypeName)
ColumnMetaData
setJdbcType(JdbcType type)
ColumnMetaData
setLength(java.lang.Integer length)
ColumnMetaData
setLength(java.lang.String length)
ColumnMetaData
setName(java.lang.String name)
ColumnMetaData
setPosition(int pos)
ColumnMetaData
setPosition(java.lang.String pos)
ColumnMetaData
setScale(java.lang.Integer scale)
ColumnMetaData
setScale(java.lang.String scale)
ColumnMetaData
setSqlType(java.lang.String sqlType)
ColumnMetaData
setTarget(java.lang.String target)
ColumnMetaData
setTargetMember(java.lang.String targetMember)
ColumnMetaData
setUnique(boolean unique)
ColumnMetaData
setUnique(java.lang.String unique)
ColumnMetaData
setUpdateable(boolean updateable)
ColumnMetaData
setUpdateable(java.lang.String updateable)
-
Methods inherited from class org.datanucleus.metadata.MetaData
addExtension, addExtensions, getExtensions, getMetaDataManager, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, initialise, isInitialised, isPopulated, isUsed, removeExtension, setExtensions, setInitialised, setParent, setPopulated, setUsed
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
name
protected java.lang.String name
column name.
-
target
protected java.lang.String target
target column name (for matching across a FK).
-
targetMember
protected java.lang.String targetMember
target field/property name (for matching across a FK).
-
jdbcType
protected JdbcType jdbcType
jdbc-type to use (if any).
-
sqlType
protected java.lang.String sqlType
sql-type to use (if any). Takes priority over jdbc-type.
-
length
protected java.lang.Integer length
length to use (if any). Also known as "precision" when for floating point types.
-
scale
protected java.lang.Integer scale
scale to use (if any).
-
allowsNull
protected java.lang.Boolean allowsNull
Whether the column accepts nulls.
-
defaultValue
protected java.lang.String defaultValue
Default value for the column (when constructing the table with this column).
-
insertValue
protected java.lang.String insertValue
value to use when inserting this column in the datastore (the column is not mapped to a field/property)
-
insertable
protected boolean insertable
Whether this column is to be inserted when the owning object is inserted. TODO Merge this with AbstractMemberMetaData.isInsertable.
-
updateable
protected boolean updateable
Whether this column can be updated when the owning object is updated. TODO Merge this with AbstractMemberMetaData.isUpdateable.
-
unique
protected boolean unique
Whether this column should be marked as UNIQUE.
-
columnDdl
protected java.lang.String columnDdl
Optional column DDL appended to the column definition defined by DataNucleus.
-
position
protected java.lang.Integer position
Column position for the table as a whole (0-origin).
-
-
Constructor Detail
-
ColumnMetaData
public ColumnMetaData(ColumnMetaData colmd)
Creates a ColumnMetaData by copying contents fromcolmd
.- Parameters:
colmd
- MetaData for the column
-
ColumnMetaData
public ColumnMetaData()
Default constructor. Set the fields using setters, before populate().
-
-
Method Detail
-
getDefaultValue
public java.lang.String getDefaultValue()
-
setDefaultValue
public ColumnMetaData setDefaultValue(java.lang.String defaultValue)
-
getColumnDdl
public java.lang.String getColumnDdl()
-
setColumnDdl
public void setColumnDdl(java.lang.String columnDdl)
-
getInsertable
public boolean getInsertable()
-
setInsertable
public ColumnMetaData setInsertable(boolean insertable)
-
setInsertable
public ColumnMetaData setInsertable(java.lang.String insertable)
-
getInsertValue
public java.lang.String getInsertValue()
-
setInsertValue
public ColumnMetaData setInsertValue(java.lang.String insertValue)
-
getJdbcType
public JdbcType getJdbcType()
-
getJdbcTypeName
public java.lang.String getJdbcTypeName()
-
setJdbcType
public ColumnMetaData setJdbcType(JdbcType type)
-
setJdbcType
public ColumnMetaData setJdbcType(java.lang.String jdbcTypeName)
-
getLength
public java.lang.Integer getLength()
-
setLength
public ColumnMetaData setLength(java.lang.Integer length)
-
setLength
public ColumnMetaData setLength(java.lang.String length)
-
getName
public java.lang.String getName()
-
setName
public ColumnMetaData setName(java.lang.String name)
-
getScale
public java.lang.Integer getScale()
-
setScale
public ColumnMetaData setScale(java.lang.Integer scale)
-
setScale
public ColumnMetaData setScale(java.lang.String scale)
-
getSqlType
public java.lang.String getSqlType()
-
setSqlType
public ColumnMetaData setSqlType(java.lang.String sqlType)
-
getTarget
public java.lang.String getTarget()
-
setTarget
public ColumnMetaData setTarget(java.lang.String target)
-
getTargetMember
public java.lang.String getTargetMember()
-
setTargetMember
public ColumnMetaData setTargetMember(java.lang.String targetMember)
-
getPosition
public java.lang.Integer getPosition()
-
setPosition
public ColumnMetaData setPosition(int pos)
-
setPosition
public ColumnMetaData setPosition(java.lang.String pos)
-
getUnique
public boolean getUnique()
-
setUnique
public ColumnMetaData setUnique(boolean unique)
-
setUnique
public ColumnMetaData setUnique(java.lang.String unique)
-
getUpdateable
public boolean getUpdateable()
-
setUpdateable
public ColumnMetaData setUpdateable(boolean updateable)
-
setUpdateable
public ColumnMetaData setUpdateable(java.lang.String updateable)
-
isAllowsNull
public boolean isAllowsNull()
-
getAllowsNull
public java.lang.Boolean getAllowsNull()
-
setAllowsNull
public ColumnMetaData setAllowsNull(java.lang.Boolean allowsNull)
-
setAllowsNull
public ColumnMetaData setAllowsNull(java.lang.String allowsNull)
-
-