Java Doc for ColumnMetaData.java in  » Database-ORM » JPOX » org » jpox » metadata » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Database ORM » JPOX » org.jpox.metadata 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jpox.metadata.MetaData
      org.jpox.metadata.ColumnMetaData

ColumnMetaData
public class ColumnMetaData extends MetaData (Code)
Representation of the Meta-Data for a column mapping of a field. JDO metadata represented is :-
 <!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>
 

since:
   1.1
version:
   $Revision: 1.20 $


Field Summary
protected  BooleanallowsNull
     allows-null tag value.
protected  StringdefaultValue
     column default value (when constructing the table with this column).
protected  StringinsertValue
    
protected  booleaninsertable
     Whether this column is to be inserted when the owning object is inserted.
protected  StringjdbcType
     jdbc-type to use (if any).
protected  Integerlength
     length to use (if any).
protected  Stringname
     column name.
protected  Integerscale
     scale to use (if any).
protected  StringsqlType
     sql-type to use (if any).
protected  Stringtarget
     target column name.
protected  StringtargetMember
     target field/property name.
protected  booleanunique
     unique tag value.
protected  booleanupdateable
     Whether this column can be updated when the owning object is updated.

Constructor Summary
public  ColumnMetaData(MetaData parent, ColumnMetaData colmd)
     Creates a ColumnMetaData by copying contents from colmd.
public  ColumnMetaData(MetaData parent, String name)
     Convenience constructor specifying just the column name, and the parent metadata component.
public  ColumnMetaData(MetaData parent, String name, String target, String targetMember, String jdbcType, String sqlType, String length, String scale, String allowsNull, String defaultValue, String insertValue, String insertable, String updateable, String unique)
     Constructor.

Method Summary
public  StringgetDefaultValue()
    
public  StringgetInsertValue()
    
public  booleangetInsertable()
     Accessor for whether this column can be inserted when the owning object is inserted.
public  StringgetJdbcType()
    
public  IntegergetLength()
     Accessor for the length tag value.
public  StringgetName()
    
public  IntegergetScale()
    
public  StringgetSqlType()
    
public  StringgetTarget()
     Accessor for the column that is the target of this column in the referenced table.
public  StringgetTargetMember()
     Accessor for the field/property that is the target of this column in the referenced class.
public  booleangetUnique()
    
public  booleangetUpdateable()
     Accessor for whether this column can be update when the owning object is updated.
public  booleanisAllowsNull()
    
public  booleanisAllowsNullSet()
     Accessor for whether the nulls allowed flag has been set.
final public  voidsetAllowsNull(Boolean allowsNull)
     Mutator for whether nulls are allowed.
final public  voidsetJdbcType(String jdbcType)
    
final public  voidsetLength(Integer length)
     Mutator for the length.
final public  voidsetLength(int length)
     Mutator for the length.
final public  voidsetName(String name)
    
final public  voidsetScale(Integer scale)
    
final public  voidsetScale(int scale)
    
final public  voidsetSqlType(String sqlType)
    
public  StringtoString(String prefix, String indent)
    

Field Detail
allowsNull
protected Boolean allowsNull(Code)
allows-null tag value.



defaultValue
protected String defaultValue(Code)
column default value (when constructing the table with this column).



insertValue
protected String insertValue(Code)
value to use when inserting this column in the datastore (the column is not mapped to a field/property)



insertable
protected boolean insertable(Code)
Whether this column is to be inserted when the owning object is inserted. JPA 1.0 attribute.



jdbcType
protected String jdbcType(Code)
jdbc-type to use (if any).



length
protected Integer length(Code)
length to use (if any). Also known as precision



name
protected String name(Code)
column name.



scale
protected Integer scale(Code)
scale to use (if any).



sqlType
protected String sqlType(Code)
sql-type to use (if any).



target
protected String target(Code)
target column name.



targetMember
protected String targetMember(Code)
target field/property name.



unique
protected boolean unique(Code)
unique tag value. JPA 1.0 attribute.



updateable
protected boolean updateable(Code)
Whether this column can be updated when the owning object is updated. JPA 1.0 attribute.




Constructor Detail
ColumnMetaData
public ColumnMetaData(MetaData parent, ColumnMetaData colmd)(Code)
Creates a ColumnMetaData by copying contents from colmd.
Parameters:
  parent - Parent MetaData component
Parameters:
  colmd - MetaData for the column



ColumnMetaData
public ColumnMetaData(MetaData parent, String name)(Code)
Convenience constructor specifying just the column name, and the parent metadata component. Assigns nulls to other parameters.
Parameters:
  parent - Parent MetaData component
Parameters:
  name - Name of the column



ColumnMetaData
public ColumnMetaData(MetaData parent, String name, String target, String targetMember, String jdbcType, String sqlType, String length, String scale, String allowsNull, String defaultValue, String insertValue, String insertable, String updateable, String unique)(Code)
Constructor.
Parameters:
  parent - parent MetaData instance
Parameters:
  name - field name
Parameters:
  target - target
Parameters:
  targetMember - target field/property
Parameters:
  jdbcType - JDBC Type to use
Parameters:
  sqlType - SQL Type to use
Parameters:
  length - length of field
Parameters:
  scale - scale of field
Parameters:
  allowsNull - Whether nulls are allowed
Parameters:
  defaultValue - The default value for the column
Parameters:
  insertValue - The insert value for the column
Parameters:
  insertable - Whether this column is insertable
Parameters:
  updateable - Whether this column is updateable
Parameters:
  unique - Whether this column is unique




Method Detail
getDefaultValue
public String getDefaultValue()(Code)
Accessor for the default value default value



getInsertValue
public String getInsertValue()(Code)
Accessor for the insert value insert value



getInsertable
public boolean getInsertable()(Code)
Accessor for whether this column can be inserted when the owning object is inserted. Whether it can be inserted.



getJdbcType
public String getJdbcType()(Code)
Accessor for the jdbc-type tag value jdbc-type tag value



getLength
public Integer getLength()(Code)
Accessor for the length tag value. Also known as precision length tag value



getName
public String getName()(Code)
Accessor for the name name



getScale
public Integer getScale()(Code)
Accessor for the scale tag value scale tag value



getSqlType
public String getSqlType()(Code)
Accessor for the sql-type tag value sql-type tag value



getTarget
public String getTarget()(Code)
Accessor for the column that is the target of this column in the referenced table. target tag value



getTargetMember
public String getTargetMember()(Code)
Accessor for the field/property that is the target of this column in the referenced class. field/property that is the target



getUnique
public boolean getUnique()(Code)
Accessor for the unique tag value unique tag value



getUpdateable
public boolean getUpdateable()(Code)
Accessor for whether this column can be update when the owning object is updated. Whether it can be updated.



isAllowsNull
public boolean isAllowsNull()(Code)
Accessor for the nulls-allowed tag value nulls-allowed tag value



isAllowsNullSet
public boolean isAllowsNullSet()(Code)
Accessor for whether the nulls allowed flag has been set. Whether it was set.



setAllowsNull
final public void setAllowsNull(Boolean allowsNull)(Code)
Mutator for whether nulls are allowed.
Parameters:
  allowsNull - The allowsNull to set.



setJdbcType
final public void setJdbcType(String jdbcType)(Code)
Mutator for the JDBC type
Parameters:
  jdbcType - The jdbcType to set.



setLength
final public void setLength(Integer length)(Code)
Mutator for the length. Also known as precision
Parameters:
  length - The length to set.



setLength
final public void setLength(int length)(Code)
Mutator for the length. Also known as precision
Parameters:
  length - The length to set.



setName
final public void setName(String name)(Code)
Mutator for the name
Parameters:
  name - The name to set.



setScale
final public void setScale(Integer scale)(Code)
Mutator for the scale
Parameters:
  scale - The scale to set.



setScale
final public void setScale(int scale)(Code)
Mutator for the scale
Parameters:
  scale - The scale to set.



setSqlType
final public void setSqlType(String sqlType)(Code)
Mutator for the SQL type
Parameters:
  sqlType - The sqlType to set.



toString
public String toString(String prefix, String indent)(Code)
Returns a string representation of the object using a prefix
Parameters:
  prefix - prefix string
Parameters:
  indent - indent string a string representation of the object.



Fields inherited from org.jpox.metadata.MetaData
final public static String JPOX_VENDOR_NAME(Code)(Java Doc)
protected static Localiser LOCALISER(Code)(Java Doc)
final public static int METADATA_CREATED_STATE(Code)(Java Doc)
final public static int METADATA_INITIALISED_STATE(Code)(Java Doc)
final public static int METADATA_POPULATED_STATE(Code)(Java Doc)
final public static int METADATA_USED_STATE(Code)(Java Doc)
protected Collection extensions(Code)(Java Doc)
protected int metaDataState(Code)(Java Doc)
protected MetaData parent(Code)(Java Doc)

Methods inherited from org.jpox.metadata.MetaData
public void addExtension(String vendor, String key, String value)(Code)(Java Doc)
public void addExtension(String key, String value)(Code)(Java Doc)
public ExtensionMetaData[] getExtensions()(Code)(Java Doc)
public int getNoOfExtensions()(Code)(Java Doc)
public MetaData getParent()(Code)(Java Doc)
public String getValueForExtension(String key)(Code)(Java Doc)
public String[] getValuesForExtension(String key)(Code)(Java Doc)
public boolean hasExtension(String key)(Code)(Java Doc)
public void initialise()(Code)(Java Doc)
public boolean isInitialised()(Code)(Java Doc)
public boolean isPopulated()(Code)(Java Doc)
public boolean isUsed()(Code)(Java Doc)
public void populate()(Code)(Java Doc)
public void removeExtension(String key)(Code)(Java Doc)
public void setInitialised()(Code)(Java Doc)
public void setParent(MetaData md)(Code)(Java Doc)
public void setPopulated()(Code)(Java Doc)
public void setUsed()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public String toString(String prefix, String indent)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.