Java Doc for JDBCEntityMetaData.java in  » EJB-Server-JBoss-4.2.1 » server » org » jboss » ejb » plugins » cmp » jdbc » 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 » EJB Server JBoss 4.2.1 » server » org.jboss.ejb.plugins.cmp.jdbc.metadata   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.jboss.ejb.plugins.cmp.jdbc.metadata.JDBCEntityMetaData JDBCEntityMetaData final public class JDBCEntityMetaData (Code) This immutable class contains information about an entity author:    Dain Sundstrom author:    Sebastien Alborini author:    Dirk Zimmermann author:    Alex Loubyansky author:    Heiko W. Rupp version:    $Revision: 57209 $ Constructor Summary public   JDBCEntityMetaData(JDBCApplicationMetaData jdbcApplication, EntityMetaData entity)      Constructs jdbc entity meta data defined in the jdbcApplication and with the data from the entity meta data which is loaded from the ejb-jar.xml file. public   JDBCEntityMetaData(JDBCApplicationMetaData jdbcApplication, Element element, JDBCEntityMetaData defaultValues)      Constructs entity meta data with the data contained in the entity xml element from a jbosscmp-jdbc xml file. Method Summary public  boolean equals(Object o)      Compares this JDBCEntityMetaData against the specified object. public  String getAbstractSchemaName()      Gets the abstract shcema name of this entity. public  boolean getAlterTable()      Gets the flag used to determine if the store manager should attempt to alter table when the entity is deployed. public  JDBCAuditMetaData getAudit()      public  JDBCCMPFieldMetaData getCMPFieldByName(String name)      public  List getCMPFields()      public  ClassLoader getClassLoader()      public  boolean getCreateTable()      Gets the flag used to determine if the store manager should attempt to create database table when the entity is deployed. public  String getDataSourceName()      public  String getDefaultTableName()      public  ArrayList getDefaultTablePostCreateCmd()      public  String getEagerLoadGroup()      Gets the name of the eager load group. public  Class getEntityClass()      public  JDBCEntityCommandMetaData getEntityCommand()      public  int getFetchSize()      The number of rows that the database driver should get in a single trip to the database. public  Class getHomeClass()      public  JDBCApplicationMetaData getJDBCApplication()      Gets the meta data for the application of which this entity is a member. public  List getLazyLoadGroups()      Gets the collection of lazy load group names. public  int getListCacheMax()      The maximum number of qurey result lists that will be tracked. public  List getLoadGroup(String name)      Gets the load group with the specified name. public  Map getLoadGroups()      Gets the map from load grou name to a List of field names, which forms a logical load group. public  Class getLocalClass()      public  Class getLocalHomeClass()      public  String getName()      Gets the name of this entity. public  JDBCOptimisticLockingMetaData getOptimisticLocking()      public  Class getPrimaryKeyClass()      public  String getPrimaryKeyFieldName()      public  Class getQLCompiler()      public  Collection getQueries()      public  JDBCQueryMetaData getQueryMetaDataForMethod(Method method)      Parameters:   method - finder method name. public  JDBCReadAheadMetaData getReadAhead()      Gets the read ahead meta data for this entity. public  int getReadTimeOut()      How long is a read of this entity valid. public  Collection getRelationshipRoles()      Get the relationsip roles of this entity. public  Class getRemoteClass()      public  boolean getRemoveTable()      Gets the flag used to determine if the store manager should attempt to remove database table when the entity is undeployed. public  boolean getThrowRuntimeExceptions()      Gets the throw-runtime-exceptions meta data for this entity. public  JDBCTypeMappingMetaData getTypeMapping()      public  boolean hasPrimaryKeyConstraint()      public  boolean hasRowLocking()      public  int hashCode()      Returns a hashcode for this JDBCEntityMetaData. public  boolean isCMP1x()      public  boolean isCleanReadAheadOnLoad()      public  boolean isReadOnly()      Is this entity read only? A readonly entity will never be stored into the database. public  boolean isThrowRuntimeExceptions()      Is the throw-runtime-exceptions meta data for this entity is true. public static  JDBCTypeMappingMetaData obtainTypeMappingFromLibrary(String dataSourceName)      public  String toString()      Returns a string describing this JDBCEntityMetaData. Constructor Detail JDBCEntityMetaData public JDBCEntityMetaData(JDBCApplicationMetaData jdbcApplication, EntityMetaData entity) throws DeploymentException(Code) Constructs jdbc entity meta data defined in the jdbcApplication and with the data from the entity meta data which is loaded from the ejb-jar.xml file. Parameters:   jdbcApplication - the application in which this entity is defined Parameters:   entity - the entity meta data for this entity that is loadedfrom the ejb-jar.xml file throws:   DeploymentException - if an problem occures while loading theclasses or if data in the ejb-jar.xml is inconsistent with datafrom jbosscmp-jdbc.xml file JDBCEntityMetaData public JDBCEntityMetaData(JDBCApplicationMetaData jdbcApplication, Element element, JDBCEntityMetaData defaultValues) throws DeploymentException(Code) Constructs entity meta data with the data contained in the entity xml element from a jbosscmp-jdbc xml file. Optional values of the xml element that are not present are loaded from the defalutValues parameter. Parameters:   jdbcApplication - the application in which this entity is defined Parameters:   element - the xml Element which contains the metadata aboutthis entity Parameters:   defaultValues - the JDBCEntityMetaData which contains the valuesfor optional elements of the element throws:   DeploymentException - if the xml element is not semantically correct Method Detail equals public boolean equals(Object o)(Code) Compares this JDBCEntityMetaData against the specified object. Returns true if the objects are the same. Two JDBCEntityMetaData are the same if they both have the same name and are defined in the same application. Parameters:   o - the reference object with which to compare true if this object is the same as the object argument;false otherwise getAbstractSchemaName public String getAbstractSchemaName()(Code) Gets the abstract shcema name of this entity. The name come from the ejb-jar.xml file. the abstract schema name of this entity getAlterTable public boolean getAlterTable()(Code) Gets the flag used to determine if the store manager should attempt to alter table when the entity is deployed. getAudit public JDBCAuditMetaData getAudit()(Code) Returns audit metadata getCMPFieldByName public JDBCCMPFieldMetaData getCMPFieldByName(String name)(Code) Gets the cmp field with the specified name Parameters:   name - the name of the desired field the cmp field with the specified name or null if not found getCMPFields public List getCMPFields()(Code) Gets the cmp fields of this entity an unmodifiable collection of JDBCCMPFieldMetaData objects getClassLoader public ClassLoader getClassLoader()(Code) Gets the class loaded which is used to load all classes used by this entity the class loader which is used to load all classes used bythis entity getCreateTable public boolean getCreateTable()(Code) Gets the flag used to determine if the store manager should attempt to create database table when the entity is deployed. true if the store manager should attempt to create the table getDataSourceName public String getDataSourceName()(Code) Gets the name of the datasource in jndi for this entity the name of datasource in jndi getDefaultTableName public String getDefaultTableName()(Code) Gets the name of the table to which this entity is persisted the name of the table to which this entity is persisted getDefaultTablePostCreateCmd public ArrayList getDefaultTablePostCreateCmd()(Code) Get the (user-defined) SQL commands that sould be issued after table creation the SQL command to issue to the DB-server getEagerLoadGroup public String getEagerLoadGroup()(Code) Gets the name of the eager load group. This name can be used to look up the load group. the name of the eager load group getEntityClass public Class getEntityClass()(Code) Gets the implementation class of this entity the implementation class of this entity getEntityCommand public JDBCEntityCommandMetaData getEntityCommand()(Code) Gets the entity command metadata the entity command metadata getFetchSize public int getFetchSize()(Code) The number of rows that the database driver should get in a single trip to the database. getHomeClass public Class getHomeClass()(Code) Gets the home class of this entity the home class of this entity getJDBCApplication public JDBCApplicationMetaData getJDBCApplication()(Code) Gets the meta data for the application of which this entity is a member. the meta data for the application that this entity is a memeber getLazyLoadGroups public List getLazyLoadGroups()(Code) Gets the collection of lazy load group names. an unmodifiable collection of load group names getListCacheMax public int getListCacheMax()(Code) The maximum number of qurey result lists that will be tracked. getLoadGroup public List getLoadGroup(String name) throws DeploymentException(Code) Gets the load group with the specified name. the load group with the specified name throws:   DeploymentException - if group with the specified name is not found getLoadGroups public Map getLoadGroups()(Code) Gets the map from load grou name to a List of field names, which forms a logical load group. an unmodifiable map of load groups (Lists) by group name. getLocalClass public Class getLocalClass()(Code) Gets the local class of this entity the local class of this entity getLocalHomeClass public Class getLocalHomeClass()(Code) Gets the local home class of this entity the local home class of this entity getName public String getName()(Code) Gets the name of this entity. The name come from the ejb-jar.xml file. the name of this entity getOptimisticLocking public JDBCOptimisticLockingMetaData getOptimisticLocking()(Code) Returns optimistic locking metadata getPrimaryKeyClass public Class getPrimaryKeyClass()(Code) Gets the primary key class for this entity the primary key class for this entity getPrimaryKeyFieldName public String getPrimaryKeyFieldName()(Code) Gets the name of the primary key field of this entity or null if the primary key is multivalued the name of the primary key field of this entity or nullif the primary key is multivalued getQLCompiler public Class getQLCompiler()(Code) getQueries public Collection getQueries()(Code) Gets the queries defined on this entity an unmodifiable collection of JDBCQueryMetaData objects getQueryMetaDataForMethod public JDBCQueryMetaData getQueryMetaDataForMethod(Method method)(Code) Parameters:   method - finder method name. corresponding query metadata or null. getReadAhead public JDBCReadAheadMetaData getReadAhead()(Code) Gets the read ahead meta data for this entity. the read ahead meta data for this entity. getReadTimeOut public int getReadTimeOut()(Code) How long is a read of this entity valid. This property should only be used on read only entities, and determines how long the data read from the database is valid. When the read times out it should be reread from the database. If the value is -1 and the entity is not using commit option a, the read is only valid for the length of the transaction in which it was loaded. the length of time that a read is valid or -1 if the read is onlyvalid for the length of the transaction getRelationshipRoles public Collection getRelationshipRoles()(Code) Get the relationsip roles of this entity. Items are instance of JDBCRelationshipRoleMetaData. an unmodifiable collection of the relationship roles definedfor this entity getRemoteClass public Class getRemoteClass()(Code) Gets the remote class of this entity the remote class of this entity getRemoveTable public boolean getRemoveTable()(Code) Gets the flag used to determine if the store manager should attempt to remove database table when the entity is undeployed. true if the store manager should attempt to remove the table getThrowRuntimeExceptions public boolean getThrowRuntimeExceptions()(Code) Gets the throw-runtime-exceptions meta data for this entity. the throw-runtime-exceptions meta data for this entity. getTypeMapping public JDBCTypeMappingMetaData getTypeMapping() throws DeploymentException(Code) Gets the jdbc type mapping for this entity the jdbc type mapping for this entity hasPrimaryKeyConstraint public boolean hasPrimaryKeyConstraint()(Code) Gets the flag used to determine if the store manager should add a priary key constraint when creating the table true if the store manager should add a primary key constraint tothe create table sql statement hasRowLocking public boolean hasRowLocking()(Code) Gets the flag used to determine if the store manager should do row locking when loading entity beans true if the store manager should add a row lockingclause when selecting data from the table hashCode public int hashCode()(Code) Returns a hashcode for this JDBCEntityMetaData. The hashcode is computed based on the hashCode of the declaring application and the hashCode of the entityName a hash code value for this object isCMP1x public boolean isCMP1x()(Code) Does this entity use CMP version 1.x true if this entity used CMP version 1.x; otherwise false isCleanReadAheadOnLoad public boolean isCleanReadAheadOnLoad()(Code) isReadOnly public boolean isReadOnly()(Code) Is this entity read only? A readonly entity will never be stored into the database. true if this entity is read only isThrowRuntimeExceptions public boolean isThrowRuntimeExceptions()(Code) Is the throw-runtime-exceptions meta data for this entity is true. the throw-runtime-exceptions meta data for this entity. obtainTypeMappingFromLibrary public static JDBCTypeMappingMetaData obtainTypeMappingFromLibrary(String dataSourceName) throws DeploymentException(Code) toString public String toString()(Code) Returns a string describing this JDBCEntityMetaData. The exact details of the representation are unspecified and subject to change, but the following may be regarded as typical: "[JDBCEntityMetaData: entityName=UserEJB]" a string representation of the object 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)