Java Doc for JoinMetaData.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.JoinMetaData

JoinMetaData
public class JoinMetaData extends MetaData implements ColumnMetaDataContainer(Code)
Secondary tables and join tables are mapped using a join condition that associates a column or columns in the secondary or join table with a column or columns in the primary table, typically the primary tables primary key columns. Column elements used for relationship mapping or join conditions specify the column name and optionally the target column name. The target column name is the name of the column in the associated table corresponding to the named column. The target column name is optional when the target column is the single primary key column of the associated table.
since:
   1.1
version:
   $Revision: 1.24 $


Field Summary
 Stringcatalog
     the catalog name.
protected  ColumnMetaData[]columnMetaData
    
 StringcolumnName
     the column name.
final  Listcolumns
    
 StringforeignKey
     the foreign-key column name.
 ForeignKeyMetaDataforeignKeyMetaData
     the foreign-key element.
 IndexMetaDataindexMetaData
     the index element.
protected  IndexedValueindexed
    
 Booleanouter
     if is outer join.
protected  PrimaryKeyMetaDataprimaryKeyMetaData
    
 Stringschema
     the schema name.
 Stringtable
     the table name.
final protected  booleanuniqueConstraint
     Whether to add a unique constraint.
 UniqueMetaDatauniqueMetaData
     the unique element.

Constructor Summary
public  JoinMetaData(MetaData parent, JoinMetaData joinmd)
     Constructor to create a copy of the passed JoinMetaData but with the passed parent.
public  JoinMetaData(MetaData parent, String table, String catalog, String schema, String columnName, String outer, String fkDeleteAction, String indexed, String unique)
     Constructor for the Join.

Method Summary
public  voidaddColumn(ColumnMetaData colmd)
    
final public  StringgetCatalog()
    
final public  ColumnMetaData[]getColumnMetaData()
    
final public  StringgetColumnName()
    
final public  ForeignKeyMetaDatagetForeignKeyMetaData()
    
final public  IndexMetaDatagetIndexMetaData()
    
final public  PrimaryKeyMetaDatagetPrimaryKeyMetaData()
    
final public  StringgetSchema()
    
final public  StringgetTable()
    
final public  UniqueMetaDatagetUniqueMetaData()
    
public  voidinitialise()
     Method to initialise the object, creating internal convenience arrays.
final public  booleanisOuter()
    
final public  voidsetForeignKeyMetaData(ForeignKeyMetaData foreignKeyMetaData)
    
final public  voidsetIndexMetaData(IndexMetaData indexMetaData)
    
final public  voidsetPrimaryKeyMetaData(PrimaryKeyMetaData primaryKeyMetaData)
     Mutator for the PrimaryKey MetaData.
final public  voidsetUniqueMetaData(UniqueMetaData uniqueMetaData)
    
public  StringtoString(String prefix, String indent)
    

Field Detail
catalog
String catalog(Code)
the catalog name.



columnMetaData
protected ColumnMetaData[] columnMetaData(Code)
Contains the metadata for column



columnName
String columnName(Code)
the column name.



columns
final List columns(Code)
column elements



foreignKey
String foreignKey(Code)
the foreign-key column name.



foreignKeyMetaData
ForeignKeyMetaData foreignKeyMetaData(Code)
the foreign-key element.



indexMetaData
IndexMetaData indexMetaData(Code)
the index element.



indexed
protected IndexedValue indexed(Code)
The indexing value



outer
Boolean outer(Code)
if is outer join. Outer joins return all elements from at least one of the sides joined.



primaryKeyMetaData
protected PrimaryKeyMetaData primaryKeyMetaData(Code)
PrimaryKey MetaData



schema
String schema(Code)
the schema name.



table
String table(Code)
the table name.



uniqueConstraint
final protected boolean uniqueConstraint(Code)
Whether to add a unique constraint.



uniqueMetaData
UniqueMetaData uniqueMetaData(Code)
the unique element.




Constructor Detail
JoinMetaData
public JoinMetaData(MetaData parent, JoinMetaData joinmd)(Code)
Constructor to create a copy of the passed JoinMetaData but with the passed parent.
Parameters:
  parent - Parent
Parameters:
  joinmd - Existing join metadata to copy



JoinMetaData
public JoinMetaData(MetaData parent, String table, String catalog, String schema, String columnName, String outer, String fkDeleteAction, String indexed, String unique)(Code)
Constructor for the Join.
Parameters:
  parent - The parent
Parameters:
  table - The table name
Parameters:
  catalog - The catalog name
Parameters:
  schema - The schema name
Parameters:
  columnName - The column name
Parameters:
  outer - Whether it is an outer join
Parameters:
  fkDeleteAction - Delete action on the FK
Parameters:
  indexed - whether the join is indexed
Parameters:
  unique - whether the join is unique




Method Detail
addColumn
public void addColumn(ColumnMetaData colmd)(Code)
Add a new ColumnMetaData element
Parameters:
  colmd - The ColumnMetaData to add



getCatalog
final public String getCatalog()(Code)
Accessor for the catalog name Returns the catalog name



getColumnMetaData
final public ColumnMetaData[] getColumnMetaData()(Code)
Accessor for columnMetaData Returns the columnMetaData.



getColumnName
final public String getColumnName()(Code)
Accessor for the column name Returns the column.



getForeignKeyMetaData
final public ForeignKeyMetaData getForeignKeyMetaData()(Code)
Returns the foreignKeyMetaData.



getIndexMetaData
final public IndexMetaData getIndexMetaData()(Code)
Returns the indexMetaData.



getPrimaryKeyMetaData
final public PrimaryKeyMetaData getPrimaryKeyMetaData()(Code)
Accessor for primaryKeyMetaData Returns the primaryKey MetaData.



getSchema
final public String getSchema()(Code)
Accessor for the schema name Returns the schema name



getTable
final public String getTable()(Code)
Accessor for the table name Returns the table name



getUniqueMetaData
final public UniqueMetaData getUniqueMetaData()(Code)
Returns the uniquexMetaData.



initialise
public void initialise()(Code)
Method to initialise the object, creating internal convenience arrays. Initialises all sub-objects.



isOuter
final public boolean isOuter()(Code)
Returns the outer.



setForeignKeyMetaData
final public void setForeignKeyMetaData(ForeignKeyMetaData foreignKeyMetaData)(Code)

Parameters:
  foreignKeyMetaData - The foreignKeyMetaData to set.



setIndexMetaData
final public void setIndexMetaData(IndexMetaData indexMetaData)(Code)

Parameters:
  indexMetaData - The indexMetaData to set.



setPrimaryKeyMetaData
final public void setPrimaryKeyMetaData(PrimaryKeyMetaData primaryKeyMetaData)(Code)
Mutator for the PrimaryKey MetaData.
Parameters:
  primaryKeyMetaData - The PrimaryKey MetaData to set.



setUniqueMetaData
final public void setUniqueMetaData(UniqueMetaData uniqueMetaData)(Code)

Parameters:
  uniqueMetaData - The uniqueMetaData 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.