Java Doc for DatastoreField.java in  » Database-ORM » JPOX » org » jpox » store » 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.store 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.jpox.store.DatastoreField

DatastoreField
public interface DatastoreField extends DatastoreObject(Code)
Representation of a Java field in a datastore. In the case of RDBMS this will be a column. In the case of a file-based structure this may be a file. In the case of an XML-based structure this may be an node.
version:
   $Revision: 1.12 $


Field Summary
final public static  intROLE_ARRAY_ELEMENT
    
final public static  intROLE_COLLECTION_ELEMENT
    
final public static  intROLE_CUSTOM
    
final public static  intROLE_FIELD
    
final public static  intROLE_INDEX
    
final public static  intROLE_MAP_KEY
    
final public static  intROLE_MAP_VALUE
    
final public static  intROLE_NONE
    
final public static  intROLE_OWNER
    


Method Summary
 StringapplySelectFunction(String replacementValue)
     Wraps the column name with a FUNCTION.
example: SQRT(?) generates: SQRT(columnName)

Parameters:
  replacementValue - the replacement to ?.
 voidcopyConfigurationTo(DatastoreField col)
    
 DatastoreContainerObjectgetDatastoreContainerObject()
    
 DatastoreMappinggetDatastoreMapping()
     Accessor for the datastore mapping that this datastore field relates to.
 AbstractMemberMetaDatagetFieldMetaData()
     Accessor for the MetaData of the field that this is the datastore field for.
 JavaTypeMappinggetMapping()
     Accessor for the Mapping for this field.
 MetaDatagetMetaData()
     Access the metadata definition defining this DatastoreField.
 StringgetStoredJavaType()
     Accessor for the type of data stored in this field.
 booleanisNullable()
     Accessor for whether the field is nullable in the datastore.
 booleanisPrimaryKey()
     Accessor for whether the field is the primary key in the datastore.
 voidsetAsPrimaryKey()
     Mutator to make the field the primary key.
 voidsetDatastoreMapping(DatastoreMapping mapping)
     Method to associate this datastore field with its mapping.
 DatastoreFieldsetDefaultable()
     Mutator for the defaultability of the datastore field.
 voidsetIdentifier(DatastoreIdentifier identifier)
     Mutator for the identifier of the column.
 voidsetMetaData(MetaData md)
     Method to set the MetaData for this datastore field.
 DatastoreFieldsetNullable()
     Mutator for the nullability of the datastore field.

Field Detail
ROLE_ARRAY_ELEMENT
final public static int ROLE_ARRAY_ELEMENT(Code)



ROLE_COLLECTION_ELEMENT
final public static int ROLE_COLLECTION_ELEMENT(Code)



ROLE_CUSTOM
final public static int ROLE_CUSTOM(Code)



ROLE_FIELD
final public static int ROLE_FIELD(Code)



ROLE_INDEX
final public static int ROLE_INDEX(Code)



ROLE_MAP_KEY
final public static int ROLE_MAP_KEY(Code)



ROLE_MAP_VALUE
final public static int ROLE_MAP_VALUE(Code)



ROLE_NONE
final public static int ROLE_NONE(Code)



ROLE_OWNER
final public static int ROLE_OWNER(Code)





Method Detail
applySelectFunction
String applySelectFunction(String replacementValue)(Code)
Wraps the column name with a FUNCTION.
example: SQRT(?) generates: SQRT(columnName)

Parameters:
  replacementValue - the replacement to ?. Probably it's a column name, that may be fully qualified name or not a String with function taking as parameter the replacementValue



copyConfigurationTo
void copyConfigurationTo(DatastoreField col)(Code)
Copy the configuration of this field to another field
Parameters:
  col - the datastore field



getDatastoreContainerObject
DatastoreContainerObject getDatastoreContainerObject()(Code)
Accessor for the DatastoreContainerObject container of this field The DatastoreContainerObject



getDatastoreMapping
DatastoreMapping getDatastoreMapping()(Code)
Accessor for the datastore mapping that this datastore field relates to. The datastore mapping



getFieldMetaData
AbstractMemberMetaData getFieldMetaData()(Code)
Accessor for the MetaData of the field that this is the datastore field for. MetaData of the field (if representing a field of a class).



getMapping
JavaTypeMapping getMapping()(Code)
Accessor for the Mapping for this field. TODO Change this to DatastoreMapping since a DatastoreField maps via that and not JavaTypeMapping. The Mapping



getMetaData
MetaData getMetaData()(Code)
Access the metadata definition defining this DatastoreField. the MetaData



getStoredJavaType
String getStoredJavaType()(Code)
Accessor for the type of data stored in this field. The type of data in the field.



isNullable
boolean isNullable()(Code)
Accessor for whether the field is nullable in the datastore. whether the field is nullable



isPrimaryKey
boolean isPrimaryKey()(Code)
Accessor for whether the field is the primary key in the datastore. whether the field is (part of) the primary key



setAsPrimaryKey
void setAsPrimaryKey()(Code)
Mutator to make the field the primary key.



setDatastoreMapping
void setDatastoreMapping(DatastoreMapping mapping)(Code)
Method to associate this datastore field with its mapping.
Parameters:
  mapping - The mapping for this datastore field



setDefaultable
DatastoreField setDefaultable()(Code)
Mutator for the defaultability of the datastore field. The datastore field with the updated info



setIdentifier
void setIdentifier(DatastoreIdentifier identifier)(Code)
Mutator for the identifier of the column.
Parameters:
  identifier - The identifier



setMetaData
void setMetaData(MetaData md)(Code)
Method to set the MetaData for this datastore field. Should only be called before completion of initialisation.
Parameters:
  md - The MetaData



setNullable
DatastoreField setNullable()(Code)
Mutator for the nullability of the datastore field. The datastore field with the updated info



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