Java Doc for Column.java in  » Database-ORM » openjpa » org » apache » openjpa » jdbc » schema » 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 » openjpa » org.apache.openjpa.jdbc.schema 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.openjpa.jdbc.schema.ReferenceCounter
      org.apache.openjpa.jdbc.schema.Column

Column
public class Column extends ReferenceCounter (Code)
Represents a database column. Closely aligned with the column information available from DatabaseMetaData .
author:
   Abe White
author:
   Stephen Kim


Field Summary
final public static  intFLAG_DIRECT_INSERT
    
final public static  intFLAG_DIRECT_UPDATE
    
final public static  intFLAG_FK_INSERT
    
final public static  intFLAG_FK_UPDATE
    
final public static  intFLAG_PK_JOIN
    
final public static  intFLAG_UNINSERTABLE
    
final public static  intFLAG_UNUPDATABLE
    

Constructor Summary
public  Column()
     Default constructor.
public  Column(String name, Table table)
     Constructor.

Method Summary
public  voidcopy(Column from)
     Copy information from the given column to this one.
public  booleanequalsColumn(Column col)
     Tests compatibility.
public  StringgetComment()
    
public  intgetDecimalDigits()
     Return the number of decimal digits for the column, if applicable.
public  ObjectgetDefault()
     Return the default value set for this column, if any.
public  StringgetDefaultString()
     Return the default value set for the column, if any.
public  StringgetDescription()
     Useful for debugging.
public  booleangetFlag(int flag)
     Flags are used for bookkeeping information.
public  StringgetFullName()
     Return the column's full name, in the form <table>.<name>.
public  intgetIndex()
     Return the column's 0-based index in the owning table.
public  intgetJavaType()
     The Java type the data in this column is treated as, from JavaTypes or JavaSQLTypes .
public  StringgetName()
     Return the column's name.
public  StringgetSchemaName()
     The column's schema name.
public  intgetSize()
     Return the column's size.
public  TablegetTable()
     Return the table for the column.
public  StringgetTableName()
     The column's table name.
public  StringgetTarget()
     The name of the column this column joins to, if any.
public  StringgetTargetField()
     The name of the field this column joins to, if any.
public  intgetType()
     Return the column's SQL type.
public  StringgetTypeName()
     The database-specific SQL type of this column.
public  VersionStrategygetVersionStrategy()
    
public  booleanhasComment()
    
public  booleanisAutoAssigned()
     Whether this column is auto-assigned a value on insert.
public  booleanisCompatible(int type, String typeName, int size, int decimals)
     Return true if this column is compatible with the given JDBC type from Types and size.
public  booleanisLob()
     Whether this column is a LOB.
public  booleanisNotNull()
     Return true if this is a NOT NULL column.
public  booleanisNotNullExplicit()
     Whether the not-null property has been set.
public  booleanisPrimaryKey()
     Return true if this column belongs to the table's primary key.
public  booleanisRelationId()
     Whether this column stores some form of serialized identity value for a related record.
public  booleanisXML()
     Whether this column is an XML type.
 voidremove()
     Called when the column is removed from its table.
public  voidresetTableName(String name)
    
public  voidsetAutoAssigned(boolean autoAssign)
     Whether this column is auto-incrementing.
public  voidsetComment(String comment)
    
public  voidsetDecimalDigits(int digits)
     Set the number of decimal digits for the column.
public  voidsetDefault(Object def)
     Set the default value for the column.
public  voidsetDefaultString(String def)
     Set the default value for the column.
public  voidsetFlag(int flag, boolean on)
     Flags are used for bookkeeping information.
 voidsetIndex(int index)
     Set the column's 0-based index in the owning table.
public  voidsetJavaType(int type)
     The Java type the data in this column is treated as, from JavaTypes or JavaSQLTypes .
public  voidsetName(String name)
     Set the column's name.
public  voidsetNotNull(boolean notNull)
     Set whether this is a NOT NULL column.
 voidsetPrimaryKey(boolean pk)
     Set whether this column belongs to the table's primary key.
public  voidsetRelationId(boolean rel)
     Whether this column stores some form of serialized identity value for a related record.
public  voidsetSchemaName(String name)
     The column's schema name.
public  voidsetSize(int size)
     Set the column's size.
public  voidsetTableName(String name)
     The column's table name.
public  voidsetTarget(String target)
     The name of the column this column joins to, if any.
public  voidsetTargetField(String target)
     The name of the field this column joins to, if any.
public  voidsetType(int sqlType)
     Set the column's SQL type.
public  voidsetTypeName(String typeName)
     The database-specific SQL type of this column.
public  voidsetVersionStrategy(VersionStrategy strategy)
    
public  StringtoString()
     Returns the column name.

Field Detail
FLAG_DIRECT_INSERT
final public static int FLAG_DIRECT_INSERT(Code)



FLAG_DIRECT_UPDATE
final public static int FLAG_DIRECT_UPDATE(Code)



FLAG_FK_INSERT
final public static int FLAG_FK_INSERT(Code)



FLAG_FK_UPDATE
final public static int FLAG_FK_UPDATE(Code)



FLAG_PK_JOIN
final public static int FLAG_PK_JOIN(Code)



FLAG_UNINSERTABLE
final public static int FLAG_UNINSERTABLE(Code)



FLAG_UNUPDATABLE
final public static int FLAG_UNUPDATABLE(Code)




Constructor Detail
Column
public Column()(Code)
Default constructor.



Column
public Column(String name, Table table)(Code)
Constructor.
Parameters:
  name - the name of the column
Parameters:
  table - the column's table




Method Detail
copy
public void copy(Column from)(Code)
Copy information from the given column to this one.



equalsColumn
public boolean equalsColumn(Column col)(Code)
Tests compatibility.



getComment
public String getComment()(Code)



getDecimalDigits
public int getDecimalDigits()(Code)
Return the number of decimal digits for the column, if applicable.



getDefault
public Object getDefault()(Code)
Return the default value set for this column, if any. If only a default string has been set, attempts to convert it to the right type based on the Java type set for this column.



getDefaultString
public String getDefaultString()(Code)
Return the default value set for the column, if any.



getDescription
public String getDescription()(Code)
Useful for debugging.



getFlag
public boolean getFlag(int flag)(Code)
Flags are used for bookkeeping information. They are ignored at runtime.



getFullName
public String getFullName()(Code)
Return the column's full name, in the form <table>.<name>.



getIndex
public int getIndex()(Code)
Return the column's 0-based index in the owning table.



getJavaType
public int getJavaType()(Code)
The Java type the data in this column is treated as, from JavaTypes or JavaSQLTypes .



getName
public String getName()(Code)
Return the column's name.



getSchemaName
public String getSchemaName()(Code)
The column's schema name.



getSize
public int getSize()(Code)
Return the column's size.



getTable
public Table getTable()(Code)
Return the table for the column.



getTableName
public String getTableName()(Code)
The column's table name.



getTarget
public String getTarget()(Code)
The name of the column this column joins to, if any. Used for mapping.



getTargetField
public String getTargetField()(Code)
The name of the field this column joins to, if any. Used for mapping.



getType
public int getType()(Code)
Return the column's SQL type. This will be one of the type constants defined in Types .



getTypeName
public String getTypeName()(Code)
The database-specific SQL type of this column.



getVersionStrategy
public VersionStrategy getVersionStrategy()(Code)



hasComment
public boolean hasComment()(Code)



isAutoAssigned
public boolean isAutoAssigned()(Code)
Whether this column is auto-assigned a value on insert.



isCompatible
public boolean isCompatible(int type, String typeName, int size, int decimals)(Code)
Return true if this column is compatible with the given JDBC type from Types and size.



isLob
public boolean isLob()(Code)
Whether this column is a LOB.



isNotNull
public boolean isNotNull()(Code)
Return true if this is a NOT NULL column.



isNotNullExplicit
public boolean isNotNullExplicit()(Code)
Whether the not-null property has been set.



isPrimaryKey
public boolean isPrimaryKey()(Code)
Return true if this column belongs to the table's primary key.



isRelationId
public boolean isRelationId()(Code)
Whether this column stores some form of serialized identity value for a related record. This makes the column dependent on the knowing the final identity of the relation before the column value is set.



isXML
public boolean isXML()(Code)
Whether this column is an XML type.



remove
void remove()(Code)
Called when the column is removed from its table. Removes the column from all table constraints and indexes, then invalidates it.



resetTableName
public void resetTableName(String name)(Code)
Reset the table name with the fully qualified table name which includes the schema name



setAutoAssigned
public void setAutoAssigned(boolean autoAssign)(Code)
Whether this column is auto-incrementing.



setComment
public void setComment(String comment)(Code)



setDecimalDigits
public void setDecimalDigits(int digits)(Code)
Set the number of decimal digits for the column.



setDefault
public void setDefault(Object def)(Code)
Set the default value for the column.



setDefaultString
public void setDefaultString(String def)(Code)
Set the default value for the column.



setFlag
public void setFlag(int flag, boolean on)(Code)
Flags are used for bookkeeping information. They are ignored at runtime.



setIndex
void setIndex(int index)(Code)
Set the column's 0-based index in the owning table.



setJavaType
public void setJavaType(int type)(Code)
The Java type the data in this column is treated as, from JavaTypes or JavaSQLTypes .



setName
public void setName(String name)(Code)
Set the column's name. You can only call this method on columns whose table object is not set.



setNotNull
public void setNotNull(boolean notNull)(Code)
Set whether this is a NOT NULL column.



setPrimaryKey
void setPrimaryKey(boolean pk)(Code)
Set whether this column belongs to the table's primary key.



setRelationId
public void setRelationId(boolean rel)(Code)
Whether this column stores some form of serialized identity value for a related record. This makes the column dependent on the knowing the final identity of the relation before the column value is set.



setSchemaName
public void setSchemaName(String name)(Code)
The column's schema name. You can only call this method on columns whose table object is not set.



setSize
public void setSize(int size)(Code)
Set the column's size.



setTableName
public void setTableName(String name)(Code)
The column's table name. You can only call this method on columns whose table object is not set.



setTarget
public void setTarget(String target)(Code)
The name of the column this column joins to, if any. Used for mapping.



setTargetField
public void setTargetField(String target)(Code)
The name of the field this column joins to, if any. Used for mapping.



setType
public void setType(int sqlType)(Code)
Set the column's SQL type. This should be one of the type constants defined in Types .



setTypeName
public void setTypeName(String typeName)(Code)
The database-specific SQL type of this column.



setVersionStrategy
public void setVersionStrategy(VersionStrategy strategy)(Code)



toString
public String toString()(Code)
Returns the column name.



Methods inherited from org.apache.openjpa.jdbc.schema.ReferenceCounter
public void deref()(Code)(Java Doc)
public int getRefCount()(Code)(Java Doc)
public void ref()(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.