Java Doc for MetaColumn.java in  » Database-ORM » ODAL » com » completex » objective » components » persistency » 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 » ODAL » com.completex.objective.components.persistency 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.completex.objective.components.persistency.MetaColumn

MetaColumn
public class MetaColumn implements ModelConsts,Cloneable,DescriptorMappable(Code)

author:
   Gennady Krizhevsky

Inner Class :public static class GeneratorStruct

Field Summary
final protected static  GeneratorStructDEFAULT_CREATION_DATE_GENERATOR_STRUCT
    
final protected static  SetDEFAULT_CREATION_DATE_NAMES
    
final protected static  GeneratorStructDEFAULT_LAST_UPDATED_GENERATOR_STRUCT
    
final protected static  SetDEFAULT_LAST_UPDATED_NAMES
    
final public static  intINDENT
    
final public static  intINDENT_2
    
protected  booleanautoGenerated
    
protected  booleanautoIncrement
    
protected  StringcolumnAlias
    
protected  intcolumnIndex
    
protected  StringcolumnName
    
protected  intcolumnSize
    
protected  GeneratorStructcreationDateNames
    
protected  intdecimalDigits
    
protected  StringdefaultValue
    
protected  booleanexclude
    
protected  StringgeneratorClassName
    
protected  MapgeneratorStaticAttributes
    
protected  booleanisPrimaryKey
    
protected  booleanisRequired
    
protected  intjdbcType
    
protected  GeneratorStructlastUpdatedNames
    
protected  booleanoptimisticLock
    
protected  Stringremarks
    
protected  MetaTabletable
    
protected  booleantransformed
    
protected  ColumnTypetype
    
protected  TypeHandlertypeHandler
    
protected  StringtypeName
    

Constructor Summary
public  MetaColumn()
    
public  MetaColumn(MetaTable table)
    
public  MetaColumn(String columnName, MetaTable table)
    
public  MetaColumn(int columnIndex, String columnName, String columnAlias, MetaTable table)
    

Method Summary
public  Objectclone()
    
public  MetaColumncloneSafe()
    
public  voidfromExternalMap(Map columnMap)
    
public  voidfromInternalMap(Map columnMap)
    
public  StringgetColumnAlias()
    
public  intgetColumnIndex()
    
public  StringgetColumnName()
    
public  intgetColumnSize()
    
public  GeneratorStructgetCreationDateNames()
    
public  intgetDecimalDigits()
    
public  StringgetDefaultValue()
    
public  StringgetFullColumnName()
     Returns fully qualified column name - prepended by table name and period.
public static  StringgetFullColumnName(String tableName, String columnName)
    
public  StringgetGeneratorClassName()
    
public  MapgetGeneratorStaticAttributes()
    
public  intgetJdbcType()
    
public  AutoKeyGeneratorgetKeyGenerator()
    
public  GeneratorStructgetLastUpdatedNames()
    
public  StringgetRemarks()
    
public  StringgetTableName()
    
public  ColumnTypegetType()
    
public  TypeHandlergetTypeHandler()
    
public  StringgetTypeName()
    
public  voidinitializeKeyGenerator()
    
public  booleanisAutoGenerated()
    
public  booleanisAutoIncrement()
    
public  booleanisExclude()
    
public  booleanisKey()
    
public static  booleanisKey(MetaColumn column)
     Returns true if the column either part of Primary Key or Optimistic Lock.
public  booleanisOptimisticLock()
    
public  booleanisPrimaryKey()
    
public  booleanisRequired()
    
public  booleanisTransformed()
    
static  Stringline(int indent, String line)
    
static  Stringline0(int indent, String line)
    
public  voidsetAutoGenerated(boolean autoGenerated)
    
public  voidsetAutoIncrement(boolean autoIncrement)
    
public  voidsetColumnAlias(String columnAlias)
    
public  voidsetColumnIndex(int columnIndex)
    
public  voidsetColumnName(String columnName)
    
public  voidsetColumnSize(int columnSize)
    
public  voidsetCreationDateNames(GeneratorStruct creationDateNames)
    
public  voidsetDecimalDigits(int decimalDigits)
    
public  voidsetDefaultValue(String defaultValue)
    
public  voidsetExclude(boolean exclude)
    
public  voidsetGeneratorClassName(String generatorClassName)
    
public  voidsetGeneratorStaticAttributes(Map generatorStaticAttributes)
    
public  voidsetJdbcType(int jdbcType)
    
public  voidsetKeyGenerator(AutoKeyGenerator keyGenerator)
    
public  voidsetLastUpdatedNames(GeneratorStruct lastUpdatedNames)
    
public  voidsetOptimisticLock(boolean optimisticLock)
    
public  voidsetPrimaryKey(boolean primaryKey)
    
public  voidsetRemarks(String remarks)
    
public  voidsetRequired(boolean required)
    
public  voidsetTable(MetaTable table)
    
public  voidsetTransformed(boolean transformed)
    
public  voidsetType(ColumnType type)
    
public  voidsetTypeHandler(TypeHandler typeHandler)
    
public  voidsetTypeName(String typeName)
    
public  MaptoExternalMap()
    
public  MaptoInternalMap()
    
public  StringtoString()
    
public  Objectv2c(Object value)
     For ColumnType.CHAR types right pads the value stored in String with spaces to the length of this MetaColumn.

Field Detail
DEFAULT_CREATION_DATE_GENERATOR_STRUCT
final protected static GeneratorStruct DEFAULT_CREATION_DATE_GENERATOR_STRUCT(Code)



DEFAULT_CREATION_DATE_NAMES
final protected static Set DEFAULT_CREATION_DATE_NAMES(Code)



DEFAULT_LAST_UPDATED_GENERATOR_STRUCT
final protected static GeneratorStruct DEFAULT_LAST_UPDATED_GENERATOR_STRUCT(Code)



DEFAULT_LAST_UPDATED_NAMES
final protected static Set DEFAULT_LAST_UPDATED_NAMES(Code)



INDENT
final public static int INDENT(Code)



INDENT_2
final public static int INDENT_2(Code)



autoGenerated
protected boolean autoGenerated(Code)
Key generator portion: keyGenerator={ databaseGenerated = FALSE # if databaseGenerated = TRUE then class/staticAttributes/dynamicAttributes - # unnecessary or will be ignored; # if databaseGenerated = FALSE class MUST be populated class=com.completex.objective.components.persistency.key.impl.SimpleSequenceKeyGeneratorImpl staticAttributes = {name=TEST_MASTER_SEQ} }



autoIncrement
protected boolean autoIncrement(Code)



columnAlias
protected String columnAlias(Code)



columnIndex
protected int columnIndex(Code)



columnName
protected String columnName(Code)



columnSize
protected int columnSize(Code)



creationDateNames
protected GeneratorStruct creationDateNames(Code)



decimalDigits
protected int decimalDigits(Code)



defaultValue
protected String defaultValue(Code)



exclude
protected boolean exclude(Code)



generatorClassName
protected String generatorClassName(Code)



generatorStaticAttributes
protected Map generatorStaticAttributes(Code)



isPrimaryKey
protected boolean isPrimaryKey(Code)



isRequired
protected boolean isRequired(Code)



jdbcType
protected int jdbcType(Code)



lastUpdatedNames
protected GeneratorStruct lastUpdatedNames(Code)



optimisticLock
protected boolean optimisticLock(Code)



remarks
protected String remarks(Code)



table
protected MetaTable table(Code)



transformed
protected boolean transformed(Code)



type
protected ColumnType type(Code)



typeHandler
protected TypeHandler typeHandler(Code)



typeName
protected String typeName(Code)




Constructor Detail
MetaColumn
public MetaColumn()(Code)



MetaColumn
public MetaColumn(MetaTable table)(Code)



MetaColumn
public MetaColumn(String columnName, MetaTable table)(Code)



MetaColumn
public MetaColumn(int columnIndex, String columnName, String columnAlias, MetaTable table)(Code)




Method Detail
clone
public Object clone() throws CloneNotSupportedException(Code)
Returns shallow copy of this column shallow copy of this column
throws:
  CloneNotSupportedException -



cloneSafe
public MetaColumn cloneSafe()(Code)



fromExternalMap
public void fromExternalMap(Map columnMap)(Code)

See Also:   DescriptorMappable



fromInternalMap
public void fromInternalMap(Map columnMap)(Code)

See Also:   DescriptorMappable



getColumnAlias
public String getColumnAlias()(Code)
Returns column alias that is used as a base for getters and setters of generated persistent objects column alias that is used as a base for getters and setters of generated persistent objects



getColumnIndex
public int getColumnIndex()(Code)
Returns 0-based column index 0-based column index



getColumnName
public String getColumnName()(Code)
Returns column name as it is in database table column name as it is in database table



getColumnSize
public int getColumnSize()(Code)
Returns column size for string column column size for string column



getCreationDateNames
public GeneratorStruct getCreationDateNames()(Code)
Returns names of columns that are supposed to have creation date value generator by default
See Also:   GeneratorStruct names of columns that are supposed to have creation date value generator by default



getDecimalDigits
public int getDecimalDigits()(Code)
Returns decimal digits for numeric column decimal digits for numeric column



getDefaultValue
public String getDefaultValue()(Code)
Returns JDBC column default value JDBC column default value



getFullColumnName
public String getFullColumnName()(Code)
Returns fully qualified column name - prepended by table name and period. If table is null for this column - only column name itself is returned fully qualified column name - prepended by table name and period. If table is null for this column - onlycolumn name itself is returned



getFullColumnName
public static String getFullColumnName(String tableName, String columnName)(Code)



getGeneratorClassName
public String getGeneratorClassName()(Code)
Returns value generator class name for this column value generator class name for this column



getGeneratorStaticAttributes
public Map getGeneratorStaticAttributes()(Code)
Returns value generator parameters that are statically set in geneterated persistent object value generator parameters that are statically set in geneterated persistent object



getJdbcType
public int getJdbcType()(Code)
Returns JDBC column type JDBC column type
See Also:   java.sql.Types



getKeyGenerator
public AutoKeyGenerator getKeyGenerator()(Code)
AutoKeyGenerator



getLastUpdatedNames
public GeneratorStruct getLastUpdatedNames()(Code)
Returns names of columns that are supposed to have last updated value generator by default
See Also:   GeneratorStruct names of columns that are supposed to have last updated value generator by default



getRemarks
public String getRemarks()(Code)
Returns JDBC column remarks JDBC column remarks



getTableName
public String getTableName()(Code)
Returns database table name database table name



getType
public ColumnType getType()(Code)
Returns column type column type
See Also:   ColumnType



getTypeHandler
public TypeHandler getTypeHandler()(Code)
Column type handler is optional - if not set default one for this ColumnType will be used TypeHandler column type handler
See Also:   TypeHandler



getTypeName
public String getTypeName()(Code)
Returns JDBC typeName JDBC typeName



initializeKeyGenerator
public void initializeKeyGenerator()(Code)
Creates and sets AutoKeyGenerator out of generator class name



isAutoGenerated
public boolean isAutoGenerated()(Code)
Returns true if value generator is to be used for this column true if value generator is to be used for this column



isAutoIncrement
public boolean isAutoIncrement()(Code)
Returns true if this column is auto incremented by database true if this column is auto incremented by database



isExclude
public boolean isExclude()(Code)
Returns true if this column has to excluded from generated persistent object true if this column has to excluded from generated persistent object



isKey
public boolean isKey()(Code)
Returns true if the column either part of Primary Key or Optimistic Lock true if the column either part of Primary Key or Optimistic Lock



isKey
public static boolean isKey(MetaColumn column)(Code)
Returns true if the column either part of Primary Key or Optimistic Lock. If column is null returns false.
Parameters:
  column - true if the column either part of Primary Key or Optimistic Lock. If column is null returns false.



isOptimisticLock
public boolean isOptimisticLock()(Code)
Returns true is this is optimistic lock column true is this is optimistic lock column



isPrimaryKey
public boolean isPrimaryKey()(Code)
Returns true if this column is part of primary key true if this column is part of primary key



isRequired
public boolean isRequired()(Code)
Returns true if this column value is required true if this column value is required



isTransformed
public boolean isTransformed()(Code)
Returns true if this column is transformed meaning that in subsequent transformations it will be skipped true if this column is transformed meaning that in subsequent transformations it will be skipped



line
static String line(int indent, String line)(Code)
Returns indented line terminated by EOL characters
Parameters:
  indent - number of spaces in line indentation
Parameters:
  line - line indented line



line0
static String line0(int indent, String line)(Code)
Returns indented line not terminated by EOL characters
Parameters:
  indent - number of spaces in line indentation
Parameters:
  line - line indented line



setAutoGenerated
public void setAutoGenerated(boolean autoGenerated)(Code)
Sets true if value generator is to be used for this column
Parameters:
  autoGenerated - true if value generator is to be used for this column



setAutoIncrement
public void setAutoIncrement(boolean autoIncrement)(Code)
Sets true if this column is auto incremented by database
Parameters:
  autoIncrement - true if this column is auto incremented by database



setColumnAlias
public void setColumnAlias(String columnAlias)(Code)
Sets column alias that is used as a base for getters and setters of generated persistent objects
Parameters:
  columnAlias - column alias that is used as a base for getters and setters of generated persistent objects



setColumnIndex
public void setColumnIndex(int columnIndex)(Code)
Sets 0-based column index
Parameters:
  columnIndex - 0-based column index



setColumnName
public void setColumnName(String columnName)(Code)
Sets column name as it is in database table
Parameters:
  columnName - column name as it is in database table



setColumnSize
public void setColumnSize(int columnSize)(Code)
Sets column size for string column
Parameters:
  columnSize - column size for string column



setCreationDateNames
public void setCreationDateNames(GeneratorStruct creationDateNames)(Code)
Sets names of columns that are supposed to have creation date value generator by default if not set yet
See Also:   GeneratorStruct
Parameters:
  creationDateNames - names of columns that are supposed to have creation date value generator by default if not set yet



setDecimalDigits
public void setDecimalDigits(int decimalDigits)(Code)
Sets decimal digits for numeric column
Parameters:
  decimalDigits - ecimal digits for numeric column



setDefaultValue
public void setDefaultValue(String defaultValue)(Code)
Sets JDBC column default value
Parameters:
  defaultValue - JDBC column default value



setExclude
public void setExclude(boolean exclude)(Code)
Sets true if this column has to excluded from generated persistent object
Parameters:
  exclude - true if this column has to excluded from generated persistent object



setGeneratorClassName
public void setGeneratorClassName(String generatorClassName)(Code)
Sets value generator class name for this column
Parameters:
  generatorClassName - value generator class name for this column



setGeneratorStaticAttributes
public void setGeneratorStaticAttributes(Map generatorStaticAttributes)(Code)
Sets value generator parameters that are statically set in geneterated persistent object
Parameters:
  generatorStaticAttributes - value generator parameters that are statically set in geneterated persistent object



setJdbcType
public void setJdbcType(int jdbcType)(Code)
Sets JDBC column type
Parameters:
  jdbcType - JDBC column type



setKeyGenerator
public void setKeyGenerator(AutoKeyGenerator keyGenerator)(Code)

Parameters:
  keyGenerator - AutoKeyGenerator



setLastUpdatedNames
public void setLastUpdatedNames(GeneratorStruct lastUpdatedNames)(Code)
Sets names of columns that are supposed to have last updated value generator by default if not set yet
See Also:   GeneratorStruct
Parameters:
  lastUpdatedNames - names of columns that are supposed to have last updated value generator by default if not set yet



setOptimisticLock
public void setOptimisticLock(boolean optimisticLock)(Code)
Sets optimisticLock true if this is optimistic lock column
Parameters:
  optimisticLock - true if this is optimistic lock column



setPrimaryKey
public void setPrimaryKey(boolean primaryKey)(Code)
Sets true if this column is part of primary key
Parameters:
  primaryKey - true if this column is part of primary key



setRemarks
public void setRemarks(String remarks)(Code)
Sets JDBC column remarks
Parameters:
  remarks - JDBC column remarks



setRequired
public void setRequired(boolean required)(Code)
Sets true if this column value is required
Parameters:
  required - true if this column value is required



setTable
public void setTable(MetaTable table)(Code)
Sets table database table name
Parameters:
  table - database table name



setTransformed
public void setTransformed(boolean transformed)(Code)
Sets true if this column is transformed meaning that in subsequent transformations it will be skipped
Parameters:
  transformed - true if this column is transformed meaning that in subsequent transformations it will be skipped



setType
public void setType(ColumnType type)(Code)
Sets column type
Parameters:
  type - column type
See Also:   ColumnType



setTypeHandler
public void setTypeHandler(TypeHandler typeHandler)(Code)
Column type handler is optional - if not set default one for this ColumnType will be used
Parameters:
  typeHandler - column type handler
See Also:   TypeHandler



setTypeName
public void setTypeName(String typeName)(Code)
Sets JDBC typeName
Parameters:
  typeName - JDBC typeName



toExternalMap
public Map toExternalMap()(Code)

See Also:   DescriptorMappable



toInternalMap
public Map toInternalMap()(Code)

See Also:   DescriptorMappable



toString
public String toString()(Code)



v2c
public Object v2c(Object value)(Code)
For ColumnType.CHAR types right pads the value stored in String with spaces to the length of this MetaColumn. For other types returns object itself
Parameters:
  value - For ColumnType.CHAR types value right paddedwith spaces to the length of this MetaColumn. For other types - object itself



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.