|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jpox.metadata.MetaData
org.jpox.metadata.ExtendableMetaData
org.jpox.metadata.ColumnMetaData
Representation of the Meta-Data for a column mapping of a field.
<!ELEMENT column (extension*)?> <!ATTLIST column name CDATA #IMPLIED> <!ATTLIST column target CDATA #IMPLIED> <!ATTLIST column target-field CDATA #IMPLIED> <!ATTLIST column jdbc-type CDATA #IMPLIED> <!ATTLIST column sql-type CDATA #IMPLIED> <!ATTLIST column length CDATA #IMPLIED> <!ATTLIST column scale CDATA #IMPLIED> <!ATTLIST column allows-null CDATA #IMPLIED> <!ATTLIST column default-value CDATA #IMPLIED> <!ATTLIST column insert-value CDATA #IMPLIED>
Field Summary | |
protected java.lang.Boolean |
allowsNull
allows-null tag value. |
protected java.lang.String |
defaultValue
column default value (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) |
protected java.lang.String |
jdbcType
jdbc-type tag value. |
protected java.lang.Integer |
length
length tag value. |
protected java.lang.String |
name
column name value. |
protected java.lang.Integer |
scale
scale tag value. |
protected java.lang.String |
sqlType
sql-type tag value. |
protected java.lang.String |
target
target tag value. |
protected java.lang.String |
targetField
target-field tag value. |
protected boolean |
updateable
Whether this column can be updated when the owning object is updated. |
Fields inherited from class org.jpox.metadata.ExtendableMetaData |
extensions, JPOX_VENDOR_NAME |
Fields inherited from class org.jpox.metadata.MetaData |
LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent |
Constructor Summary | |
ColumnMetaData(ExtendableMetaData parent,
ColumnMetaData colmd)
Creates a ColumnMetaData by copying contents from colmd . |
|
ColumnMetaData(ExtendableMetaData parent,
java.lang.String name)
Convenience constructor specifying just the column name, and the parent metadata component. |
|
ColumnMetaData(ExtendableMetaData parent,
java.lang.String name,
java.lang.String target,
java.lang.String targetField,
java.lang.String jdbcType,
java.lang.String sqlType,
java.lang.String length,
java.lang.String scale,
java.lang.String allowsNull,
java.lang.String defaultValue,
java.lang.String insertValue)
Constructor. |
Method Summary | |
java.lang.String |
getDefaultValue()
Accessor for the default value |
boolean |
getInsertable()
Accessor for whether this column can be inserted when the owning object is inserted. |
java.lang.String |
getInsertValue()
Accessor for the insert value |
java.lang.String |
getJdbcType()
Accessor for the jdbc-type tag value |
java.lang.Integer |
getLength()
Accessor for the length tag value. |
java.lang.String |
getName()
Accessor for the name |
java.lang.Integer |
getScale()
Accessor for the scale tag value |
java.lang.String |
getSqlType()
Accessor for the sql-type tag value |
java.lang.String |
getTarget()
Accessor for the target tag value |
java.lang.String |
getTargetField()
Accessor for the target-field tag value |
boolean |
getUpdateable()
Accessor for whether this column can be update when the owning object is updated. |
boolean |
isAllowsNull()
Accessor for the nulls-allowed tag value |
boolean |
isAllowsNullSet()
Accessor for whether the nulls allowed flag has been set. |
void |
setAllowsNull(java.lang.Boolean allowsNull)
Mutator for whether nulls are allowed. |
void |
setJdbcType(java.lang.String jdbcType)
Mutator for the JDBC type |
void |
setLength(int length)
Mutator for the length. |
void |
setLength(java.lang.Integer length)
Mutator for the length. |
void |
setName(java.lang.String name)
Mutator for the name |
void |
setScale(int scale)
Mutator for the scale |
void |
setScale(java.lang.Integer scale)
Mutator for the scale |
void |
setSqlType(java.lang.String sqlType)
Mutator for the SQL type |
java.lang.String |
toString()
Accessor for a string representation of the object. |
java.lang.String |
toString(java.lang.String prefix,
java.lang.String indent)
Returns a string representation of the object using a prefix |
Methods inherited from class org.jpox.metadata.ExtendableMetaData |
addExtension, addExtension, getExtension, getExtensions, getNoOfExtensions, getValueForExtension, getValuesForExtension, getValuesForExtensionStartingWith, hasExtension, removeExtension |
Methods inherited from class org.jpox.metadata.MetaData |
getParent, initialise, isCreated, isInitialised, isPopulated, isUsed, populate, setInitialised, setPopulated, setUsed |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected java.lang.String name
protected java.lang.String target
protected java.lang.String targetField
protected java.lang.String jdbcType
protected java.lang.String sqlType
protected java.lang.Integer length
protected java.lang.Integer scale
protected java.lang.Boolean allowsNull
protected java.lang.String defaultValue
protected java.lang.String insertValue
protected boolean insertable
protected boolean updateable
Constructor Detail |
public ColumnMetaData(ExtendableMetaData parent, ColumnMetaData colmd)
colmd
.
parent
- Parent MetaData componentcolmd
- MetaData for the columnpublic ColumnMetaData(ExtendableMetaData parent, java.lang.String name)
parent
- Parent MetaData componentname
- Name of the columnpublic ColumnMetaData(ExtendableMetaData parent, java.lang.String name, java.lang.String target, java.lang.String targetField, java.lang.String jdbcType, java.lang.String sqlType, java.lang.String length, java.lang.String scale, java.lang.String allowsNull, java.lang.String defaultValue, java.lang.String insertValue)
parent
- parent MetaData instancename
- field nametarget
- targettargetField
- target fieldjdbcType
- JDBC Type to usesqlType
- SQL Type to uselength
- length of fieldscale
- scale of fieldallowsNull
- Whether nulls are alloweddefaultValue
- The default value for the columninsertValue
- The insert value for the columnMethod Detail |
public java.lang.String getName()
public java.lang.String getTarget()
public java.lang.String getTargetField()
public java.lang.String getJdbcType()
public java.lang.String getSqlType()
public java.lang.Integer getLength()
public java.lang.Integer getScale()
public boolean isAllowsNullSet()
public boolean isAllowsNull()
public java.lang.String getDefaultValue()
public java.lang.String getInsertValue()
public boolean getInsertable()
public boolean getUpdateable()
public final void setScale(java.lang.Integer scale)
scale
- The scale to set.public final void setScale(int scale)
scale
- The scale to set.public final void setJdbcType(java.lang.String jdbcType)
jdbcType
- The jdbcType to set.public final void setLength(java.lang.Integer length)
length
- The length to set.public final void setLength(int length)
length
- The length to set.public final void setName(java.lang.String name)
name
- The name to set.public final void setAllowsNull(java.lang.Boolean allowsNull)
allowsNull
- The allowsNull to set.public final void setSqlType(java.lang.String sqlType)
sqlType
- The sqlType to set.public java.lang.String toString()
toString
in class ExtendableMetaData
public java.lang.String toString(java.lang.String prefix, java.lang.String indent)
toString
in class ExtendableMetaData
prefix
- prefix stringindent
- indent string
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |