Interface EJBInfoHelper
-
- All Known Implementing Classes:
EJBBundleInfoHelper
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ConversionHelper
createConversionHelper()
Creates and returns an instance of the ConversionHelper object to use for this helper.AbstractNameMapper
createUniqueNameMapper()
Creates and returns an instance of the AbstractNameMapper object to use for generation of unique names with this helper.Collection
getAvailableSchemaNames()
Gets a collection of names of schemas defined in this ejb jar.ClassLoader
getClassLoader()
Gets the class loader which corresponds to this ejb jar.String
getEjbJarDisplayName()
Gets the name of the ejb jar.Collection
getEjbNames()
Gets a collection of names of cmp entity beans defined in this ejb jar.Collection
getFieldsForEjb(String ejbName)
Gets a collection of names of cmp fields and cmr fields defined in this ejb jar for the specified ejb.Model
getModel()
Gets the Model object to use for this helper.AbstractNameMapper
getNameMapper()
Gets the AbstractNameMapper object to use for this helper.Collection
getRelationshipsForEjb(String ejbName)
Gets a collection of names of cmr fields defined in this ejb jar for the specified ejb.org.netbeans.modules.dbschema.SchemaElement
getSchema(String schemaName)
Gets the schema with the specified name, loading it if necessary.String
getSchemaNameToGenerate()
Gets the name to use for schema generation.
-
-
-
Method Detail
-
getEjbJarDisplayName
String getEjbJarDisplayName()
Gets the name of the ejb jar.- Returns:
- the name of the ejb jar
-
getAvailableSchemaNames
Collection getAvailableSchemaNames()
Gets a collection of names of schemas defined in this ejb jar.- Returns:
- a collection schema names
-
getSchemaNameToGenerate
String getSchemaNameToGenerate()
Gets the name to use for schema generation. An example might be a combo of app name, module name, etc.- Returns:
- the name to use for schema generation
-
getSchema
org.netbeans.modules.dbschema.SchemaElement getSchema(String schemaName)
Gets the schema with the specified name, loading it if necessary.- Parameters:
schemaName
- the name of the schema to be loaded- Returns:
- the schema object
-
getEjbNames
Collection getEjbNames()
Gets a collection of names of cmp entity beans defined in this ejb jar.- Returns:
- a collection cmp ejb names
-
getFieldsForEjb
Collection getFieldsForEjb(String ejbName)
Gets a collection of names of cmp fields and cmr fields defined in this ejb jar for the specified ejb.- Parameters:
ejbName
- the name of the ejb for which a list of fields will be created- Returns:
- a collection cmp and cmr field names
-
getRelationshipsForEjb
Collection getRelationshipsForEjb(String ejbName)
Gets a collection of names of cmr fields defined in this ejb jar for the specified ejb.- Parameters:
ejbName
- the name of the ejb for which a list of cmr fields will be created- Returns:
- a collection cmr field names
-
getClassLoader
ClassLoader getClassLoader()
Gets the class loader which corresponds to this ejb jar. Implementations can returnnull
if this is not relevant.- Returns:
- the class loader which corresponds to this ejb jar
-
getNameMapper
AbstractNameMapper getNameMapper()
Gets the AbstractNameMapper object to use for this helper.- Returns:
- the name mapper object
-
createUniqueNameMapper
AbstractNameMapper createUniqueNameMapper()
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.- Returns:
- the name mapper object
-
createConversionHelper
ConversionHelper createConversionHelper()
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.- Returns:
- the conversion helper object
-
getModel
Model getModel()
Gets the Model object to use for this helper.- Returns:
- the model object
-
-