FileDocCategorySizeDatePackage
EJBInfoHelper.javaAPI DocGlassfish v2 API5287Fri May 04 22:34:42 BST 2007com.sun.jdo.api.persistence.mapping.ejb

EJBInfoHelper

public interface EJBInfoHelper
This is an interface which represents information found in the ejb-jar.xml descriptor and provides a variety of other information and helper objects needed to do mapping and generating of ejb related things in persistence.
author
Rochelle Raccah

Fields Summary
Constructors Summary
Methods Summary
public ConversionHelpercreateConversionHelper()
Creates and returns an instance of the ConversionHelper object to use for this helper. Note that this method is a factory-like method which creates a new instance so the caller can make modifications to it as necessary.

return
the conversion helper object

public AbstractNameMappercreateUniqueNameMapper()
Creates and returns an instance of the AbstractNameMapper object to use for generation of unique names with this helper. Unique names usually means that the mapper doesn't use the same jdo and ejb names. Note that this method is a factory-like method which creates a new instance so the caller can make modifications to it as necessary.

return
the name mapper object

public java.util.CollectiongetAvailableSchemaNames()
Gets a collection of names of schemas defined in this ejb jar.

return
a collection schema names

public java.lang.ClassLoadergetClassLoader()
Gets the class loader which corresponds to this ejb jar. Implementations can return null if this is not relevant.

return
the class loader which corresponds to this ejb jar

public java.lang.StringgetEjbJarDisplayName()
Gets the name of the ejb jar.

return
the name of the ejb jar

public java.util.CollectiongetEjbNames()
Gets a collection of names of cmp entity beans defined in this ejb jar.

return
a collection cmp ejb names

public java.util.CollectiongetFieldsForEjb(java.lang.String ejbName)
Gets a collection of names of cmp fields and cmr fields defined in this ejb jar for the specified ejb.

param
ejbName the name of the ejb for which a list of fields will be created
return
a collection cmp and cmr field names

public com.sun.jdo.api.persistence.model.ModelgetModel()
Gets the Model object to use for this helper.

return
the model object

public AbstractNameMappergetNameMapper()
Gets the AbstractNameMapper object to use for this helper.

return
the name mapper object

public java.util.CollectiongetRelationshipsForEjb(java.lang.String ejbName)
Gets a collection of names of cmr fields defined in this ejb jar for the specified ejb.

param
ejbName the name of the ejb for which a list of cmr fields will be created
return
a collection cmr field names

public org.netbeans.modules.dbschema.SchemaElementgetSchema(java.lang.String schemaName)
Gets the schema with the specified name, loading it if necessary.

param
schemaName the name of the schema to be loaded
return
the schema object

public java.lang.StringgetSchemaNameToGenerate()
Gets the name to use for schema generation. An example might be a combo of app name, module name, etc.

return
the name to use for schema generation