Save This Page
Home » jboss-5.0.0.CR1-src » org.jboss.ejb.plugins.cmp » jdbc » metadata » [javadoc | source]
org.jboss.ejb.plugins.cmp.jdbc.metadata
public final class: JDBCEntityMetaData [javadoc | source]
java.lang.Object
   org.jboss.ejb.plugins.cmp.jdbc.metadata.JDBCEntityMetaData
This immutable class contains information about an entity
Constructor:
 public JDBCEntityMetaData(JDBCApplicationMetaData jdbcApplication,
    EntityMetaData entity) throws DeploymentException 
    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
    entity - the entity meta data for this entity that is loaded from the ejb-jar.xml file
    Throws:
    DeploymentException - if an problem occures while loading the classes or if data in the ejb-jar.xml is inconsistent with data from jbosscmp-jdbc.xml file
 public JDBCEntityMetaData(JDBCApplicationMetaData jdbcApplication,
    Element element,
    JDBCEntityMetaData defaultValues) throws DeploymentException 
    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
    element - the xml Element which contains the metadata about this entity
    defaultValues - the JDBCEntityMetaData which contains the values for optional elements of the element
    Throws:
    DeploymentException - if the xml element is not semantically correct
Method from org.jboss.ejb.plugins.cmp.jdbc.metadata.JDBCEntityMetaData Summary:
equals,   getAbstractSchemaName,   getAlterTable,   getAudit,   getCMPFieldByName,   getCMPFields,   getClassLoader,   getCreateTable,   getDataSourceName,   getDefaultTableName,   getDefaultTablePostCreateCmd,   getEagerLoadGroup,   getEntityClass,   getEntityCommand,   getFetchSize,   getHomeClass,   getJDBCApplication,   getLazyLoadGroups,   getListCacheMax,   getLoadGroup,   getLoadGroups,   getLocalClass,   getLocalHomeClass,   getName,   getOptimisticLocking,   getPrimaryKeyClass,   getPrimaryKeyFieldName,   getQLCompiler,   getQueries,   getQueryMetaDataForMethod,   getReadAhead,   getReadTimeOut,   getRelationshipRoles,   getRemoteClass,   getRemoveTable,   getThrowRuntimeExceptions,   getTypeMapping,   hasPrimaryKeyConstraint,   hasRowLocking,   hashCode,   isCMP1x,   isCleanReadAheadOnLoad,   isReadOnly,   isThrowRuntimeExceptions,   obtainTypeMappingFromLibrary,   toString
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jboss.ejb.plugins.cmp.jdbc.metadata.JDBCEntityMetaData Detail:
 public boolean equals(Object o) 
    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.
 public String getAbstractSchemaName() 
    Gets the abstract shcema name of this entity. The name come from the ejb-jar.xml file.
 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() 
    Returns audit metadata
 public JDBCCMPFieldMetaData getCMPFieldByName(String name) 
    Gets the cmp field with the specified name
 public List getCMPFields() 
    Gets the cmp fields of this entity
 public ClassLoader getClassLoader() 
    Gets the class loaded which is used to load all classes used by this entity
 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() 
    Gets the name of the datasource in jndi for this entity
 public String getDefaultTableName() 
    Gets the name of the table to which this entity is persisted
 public ArrayList getDefaultTablePostCreateCmd() 
    Get the (user-defined) SQL commands that sould be issued after table creation
 public String getEagerLoadGroup() 
    Gets the name of the eager load group. This name can be used to look up the load group.
 public Class getEntityClass() 
    Gets the implementation class of this entity
 public JDBCEntityCommandMetaData getEntityCommand() 
    Gets the entity command metadata
 public int getFetchSize() 
    The number of rows that the database driver should get in a single trip to the database.
 public Class getHomeClass() 
    Gets the home class of this entity
 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) throws DeploymentException 
    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() 
    Gets the local class of this entity
 public Class getLocalHomeClass() 
    Gets the local home class of this entity
 public String getName() 
    Gets the name of this entity. The name come from the ejb-jar.xml file.
 public JDBCOptimisticLockingMetaData getOptimisticLocking() 
    Returns optimistic locking metadata
 public Class getPrimaryKeyClass() 
    Gets the primary key class for this entity
 public String getPrimaryKeyFieldName() 
    Gets the name of the primary key field of this entity or null if the primary key is multivalued
 public Class getQLCompiler() 
 public Collection getQueries() 
    Gets the queries defined on this entity
 public JDBCQueryMetaData getQueryMetaDataForMethod(Method method) 
 public JDBCReadAheadMetaData getReadAhead() 
    Gets the read ahead meta data for this entity.
 public int getReadTimeOut() 
    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.
 public Collection getRelationshipRoles() 
    Get the relationsip roles of this entity. Items are instance of JDBCRelationshipRoleMetaData.
 public Class getRemoteClass() 
    Gets the remote class of this entity
 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() throws DeploymentException 
    Gets the jdbc type mapping for this entity
 public boolean hasPrimaryKeyConstraint() 
    Gets the flag used to determine if the store manager should add a priary key constraint when creating the table
 public boolean hasRowLocking() 
    Gets the flag used to determine if the store manager should do row locking when loading entity beans
 public int hashCode() 
    Returns a hashcode for this JDBCEntityMetaData. The hashcode is computed based on the hashCode of the declaring application and the hashCode of the entityName
 public boolean isCMP1x() 
    Does this entity use CMP version 1.x
 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) throws DeploymentException 
 public String toString() 
    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]"