Module org.eclipse.persistence.dbws.builder

Package org.eclipse.persistence.tools.dbws

Class BaseDBWSBuilderHelper

java.lang.Object

org.eclipse.persistence.tools.dbws.BaseDBWSBuilderHelper

Direct Known Subclasses:

JDBCHelper, OracleHelper

public abstract class BaseDBWSBuilderHelper
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AND_STR
static final String	COMMA_SPACE_STR
protected List<CompositeDatabaseType>	complextypes
protected Map<String,ClassDescriptor>	createdORDescriptors
protected Map<String,Map<String,String>>	crudOps
protected List<ProcedureType>	dbStoredProcedures
protected List<TableType>	dbTables
protected DBWSBuilder	dbwsBuilder
static final String	DELETE_STR
static final String	EQUALS_BINDING_STR
static final String	EQUALS_BINDING1_STR
static final String	INSERT_STR
static final String	ITEM_MAPPING_NAME
static final String	ITEMS_MAPPING_ATTRIBUTE_NAME
static final String	ITEMS_MAPPING_FIELD_NAME
static final String	MTOM_STR
protected NamingConventionTransformer	nct
static final String	NO_PROC_MSG
static final String	NO_TABLE_MSG
static final String	ORM_MARSHAL_EX_MSG
static final String	OXM_MARSHAL_EX_MSG
static final String	PASSWORD_STR
protected List<String>	referencedORDescriptors
static final String	SELECT_FROM_STR
protected XMLSessionConfigProject_11_1_1	sessionConfigProject
static final String	SET_STR
static final String	SIMPLEXML_STR
static final String	SWAREF_STR
static final String	TIMESTAMP_CLASS
static final String	UPDATE_STR
static final String	USER_STR
static final String	VALUES_STR
static final String	WHERE_STR
protected ObjectPersistenceWorkbenchXMLProject	workbenchXMLProject

Constructor Summary

Constructors

Constructor	Description
BaseDBWSBuilderHelper(DBWSBuilder dbwsBuilder)

Method Summary

Modifier and Type	Method	Description
protected void	addToOROXProjectsForBuildSql(ModelWithBuildSql modelWithBuildSql, Project orProject, Project oxProject, NamingConventionTransformer nct)
protected abstract void	addToOROXProjectsForComplexTypes(List<CompositeDatabaseType> types, Project orProject, Project oxProject)
protected DatabaseType	buildDatabaseTypeFromMetadataType(DatabaseType dType)	Build a org.eclipse.persistence.internal.helper.DatabaseType instance from an org.eclipse.persistence.tools.oracleddl.metadata.DatabaseType instance.
protected DatabaseType	buildDatabaseTypeFromMetadataType(DatabaseType dType, String catalog)	Build a org.eclipse.persistence.internal.helper.DatabaseType instance from an org.eclipse.persistence.tools.oracleddl.metadata.DatabaseType instance.
void	buildDbArtifacts()	Gather table and procedure information based on TableOperation and ProcedureOperation.
protected static List<DbColumn>	buildDbColumns(Connection connection, String secondarySql)
void	buildDBWSModel(NamingConventionTransformer nct, OutputStream dbwsServiceStream)	Build the DBWS model, a.k.a.
protected DirectToFieldMapping	buildORFieldMappingFromColumn(FieldType dbColumn, RelationalDescriptor desc, DatabasePlatform databasePlatform, NamingConventionTransformer nct)
void	buildOROXProjects(NamingConventionTransformer nct)	Builds OR/OX projects, descriptors & mappings.
void	buildOROXProjects(NamingConventionTransformer nct, List<CompositeDatabaseType> types)	Builds OR/OX projects, descriptors & mappings, based on a given list of types, as well as table(s) and secondary SQL.
protected XMLDirectMapping	buildOXFieldMappingFromColumn(FieldType dbColumn, DatabasePlatform databasePlatform, NamingConventionTransformer nct)
protected abstract void	buildQueryForProcedureType(ProcedureType procType, Project orProject, Project oxProject, ProcedureOperationModel opModel, boolean hasComplexArgs)
void	buildSchema(NamingConventionTransformer nct)	Build the schema
void	buildSessionsXML(OutputStream dbwsSessionsStream)	Build the sessions xml file.
List<CompositeDatabaseType>	buildTypesList(List<OperationModel> operations)	Uses a custom visitor to traverse each procedure/function argument and build a list of required Types.
void	buildWSDL(OutputStream wsdlStream, NamingConventionTransformer nct)
protected void	finishProcedureOperation()	Perform any additional actions required for operation creation for both PL/SQL and non-PL/SQL operation models.
protected void	finishUpProjects(Project orProject, Project oxProject, List<CompositeDatabaseType> typeList)	Complete project configuration.
void	generateDBWSProvider(OutputStream sourceProviderStream, OutputStream classProviderStream, OutputStream sourceProviderListenerStream, OutputStream classProviderListenerStream)
protected List<ArgumentType>	getArgumentListForProcedureType(ProcedureType pType)	Return a list of ArgumentTypes for a given Procedure Type.
List<ProcedureType>	getDbStoredProcedures()
List<TableType>	getDbTables()
protected static ResultSetMetaData	getResultSetMetadataForSecondarySQL(Connection connection, String secondarySql)	Return a ResultSetMetaData instance for a given SQL statement.
protected static String	getTypeNameForDatabaseType(DatabaseType dataType)	Return the type name to be used for a given database type.
protected Class	getWrapperClass(String wrapperClassName)	Return the wrapper class for a wrapper class name.
protected Class	getWrapperClass(DatabaseType databaseType)	Return the wrapper class for a given DatabaseType.
protected void	handleSimpleXMLFormat(boolean isSimpleXMLFormat, Result result, ProcedureOperationModel procedureOperationModel)	Apply SimpleXMLFormat if 'isSimpleXMLFormat' is true.
abstract boolean	hasTables()
protected abstract List<ProcedureType>	loadProcedures(List<String> catalogPatterns, List<String> schemaPatterns, List<String> procedureNamePatterns)
protected abstract List<TableType>	loadTables(List<String> catalogPatterns, List<String> schemaPatterns, List<String> tableNamePatterns)
protected void	logNotFoundWarnings(String message, List<String> schemaPatterns, List<String> catalogPatterns, List<String> targetPatterns)	Log a WARNING with the DBWSBuilder when a target (table, package, stored procedure/function, etc) cannot be found using the information given by the user.
protected void	logPackageNotFoundWarnings(String message, List<String> schemaPatterns, List<String> catalogPatterns)	Log a WARNING with the DBWSBuilder when a package cannot be found using the information given by the user.
protected NamingConventionTransformer	setUpCustomTransformer(String tableName, NamingConventionTransformer nct)
protected static DirectToFieldMapping	setUpDirectToFieldMapping(RelationalDescriptor desc, String columnName, NamingConventionTransformer nct, Class<?> attributeClass, int jdbcType, boolean isPk)
protected void	setUpFindQueries(NamingConventionTransformer nct, String tableName, RelationalDescriptor desc)	Generates 'findByPrimaryKey' and 'findAll' queries for a given table and descriptor.
protected XMLDirectMapping	setUpXMLDirectMapping(String columnName, QName qName, NamingConventionTransformer nct, Class<?> attributeClass, int jdbcType, boolean isPk)
void	writeAttachmentSchema(OutputStream swarefStream)
void	writeDeploymentDescriptor(OutputStream deploymentDescriptorStream)	Write the (optional) deployment descriptor to the given OutputStream.
void	writeOROXProjects(OutputStream dbwsOrStream, OutputStream dbwsOxStream)
void	writeSchema(OutputStream dbwsSchemaStream)
void	writeWebXML(OutputStream webXmlStream)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ITEM_MAPPING_NAME

public static final String ITEM_MAPPING_NAME

See Also:

• Constant Field Values

ITEMS_MAPPING_ATTRIBUTE_NAME

public static final String ITEMS_MAPPING_ATTRIBUTE_NAME

See Also:

• Constant Field Values

ITEMS_MAPPING_FIELD_NAME

public static final String ITEMS_MAPPING_FIELD_NAME

See Also:

• Constant Field Values

MTOM_STR

public static final String MTOM_STR

See Also:

• Constant Field Values

SWAREF_STR

public static final String SWAREF_STR

See Also:

• Constant Field Values

NO_TABLE_MSG

public static final String NO_TABLE_MSG

See Also:

• Constant Field Values

NO_PROC_MSG

public static final String NO_PROC_MSG

See Also:

• Constant Field Values

OXM_MARSHAL_EX_MSG

public static final String OXM_MARSHAL_EX_MSG

See Also:

• Constant Field Values

ORM_MARSHAL_EX_MSG

public static final String ORM_MARSHAL_EX_MSG

See Also:

• Constant Field Values

SELECT_FROM_STR

public static final String SELECT_FROM_STR

See Also:

• Constant Field Values

WHERE_STR

public static final String WHERE_STR

See Also:

• Constant Field Values

AND_STR

public static final String AND_STR

See Also:

• Constant Field Values

SET_STR

public static final String SET_STR

See Also:

• Constant Field Values

VALUES_STR

public static final String VALUES_STR

See Also:

• Constant Field Values

UPDATE_STR

public static final String UPDATE_STR

See Also:

• Constant Field Values

INSERT_STR

public static final String INSERT_STR

See Also:

• Constant Field Values

DELETE_STR

public static final String DELETE_STR

See Also:

• Constant Field Values

COMMA_SPACE_STR

public static final String COMMA_SPACE_STR

See Also:

• Constant Field Values

EQUALS_BINDING1_STR

public static final String EQUALS_BINDING1_STR

See Also:

• Constant Field Values

EQUALS_BINDING_STR

public static final String EQUALS_BINDING_STR

See Also:

• Constant Field Values

TIMESTAMP_CLASS

public static final String TIMESTAMP_CLASS

See Also:

• Constant Field Values

USER_STR

public static final String USER_STR

See Also:

• Constant Field Values

PASSWORD_STR

public static final String PASSWORD_STR

See Also:

• Constant Field Values

SIMPLEXML_STR

public static final String SIMPLEXML_STR

See Also:

• Constant Field Values

dbTables

protected List<TableType> dbTables

dbStoredProcedures

protected List<ProcedureType> dbStoredProcedures

dbwsBuilder

protected DBWSBuilder dbwsBuilder

sessionConfigProject

protected XMLSessionConfigProject_11_1_1 sessionConfigProject

nct

protected NamingConventionTransformer nct

workbenchXMLProject

protected ObjectPersistenceWorkbenchXMLProject workbenchXMLProject

createdORDescriptors

protected Map<String,ClassDescriptor> createdORDescriptors

referencedORDescriptors

protected List<String> referencedORDescriptors

complextypes

protected List<CompositeDatabaseType> complextypes

crudOps

protected Map<String,Map<String,String>> crudOps

Constructor Details

BaseDBWSBuilderHelper

public BaseDBWSBuilderHelper(DBWSBuilder dbwsBuilder)

Method Details

getDbTables

public List<TableType> getDbTables()

getDbStoredProcedures

public List<ProcedureType> getDbStoredProcedures()

hasTables

public abstract boolean hasTables()

loadTables

protected abstract List<TableType> loadTables(List<String> catalogPatterns,
 List<String> schemaPatterns,
 List<String> tableNamePatterns)

loadProcedures

protected abstract List<ProcedureType> loadProcedures(List<String> catalogPatterns,
 List<String> schemaPatterns,
 List<String> procedureNamePatterns)

addToOROXProjectsForComplexTypes

protected abstract void addToOROXProjectsForComplexTypes(List<CompositeDatabaseType> types,
 Project orProject,
 Project oxProject)

buildQueryForProcedureType

protected abstract void buildQueryForProcedureType(ProcedureType procType,
 Project orProject,
 Project oxProject,
 ProcedureOperationModel opModel,
 boolean hasComplexArgs)

addToOROXProjectsForBuildSql

protected void addToOROXProjectsForBuildSql(ModelWithBuildSql modelWithBuildSql,
 Project orProject,
 Project oxProject,
 NamingConventionTransformer nct)

buildTypesList

public List<CompositeDatabaseType> buildTypesList(List<OperationModel> operations)

Uses a custom visitor to traverse each procedure/function argument and build a list of required Types. Only on instance of a given type will exist in the list.

buildOROXProjects

public void buildOROXProjects(NamingConventionTransformer nct)

Builds OR/OX projects, descriptors & mappings. This method can be used when no complex types exist, and only table(s) and secondary SQL will be used when building.

buildOROXProjects

public void buildOROXProjects(NamingConventionTransformer nct,
 List<CompositeDatabaseType> types)

Builds OR/OX projects, descriptors & mappings, based on a given list of types, as well as table(s) and secondary SQL.

finishUpProjects

protected void finishUpProjects(Project orProject,
 Project oxProject,
 List<CompositeDatabaseType> typeList)

Complete project configuration. Build descriptors for secondary SQL and complex arguments. Set the projects on the DBWSBuilder instance.

buildORFieldMappingFromColumn

protected DirectToFieldMapping buildORFieldMappingFromColumn(FieldType dbColumn,
 RelationalDescriptor desc,
 DatabasePlatform databasePlatform,
 NamingConventionTransformer nct)

buildOXFieldMappingFromColumn

protected XMLDirectMapping buildOXFieldMappingFromColumn(FieldType dbColumn,
 DatabasePlatform databasePlatform,
 NamingConventionTransformer nct)

buildDbArtifacts

public void buildDbArtifacts()

Gather table and procedure information based on TableOperation and ProcedureOperation. End result will be List<TableType> and List<ProcedureType>.

buildSchema

public void buildSchema(NamingConventionTransformer nct)

Build the schema

buildSessionsXML

public void buildSessionsXML(OutputStream dbwsSessionsStream)

Build the sessions xml file.

buildDBWSModel

public void buildDBWSModel(NamingConventionTransformer nct,
 OutputStream dbwsServiceStream)

Build the DBWS model, a.k.a. service file.

writeAttachmentSchema

public void writeAttachmentSchema(OutputStream swarefStream)

buildWSDL

public void buildWSDL(OutputStream wsdlStream,
 NamingConventionTransformer nct)
               throws javax.wsdl.WSDLException

Throws:

javax.wsdl.WSDLException

writeWebXML

public void writeWebXML(OutputStream webXmlStream)

writeDeploymentDescriptor

public void writeDeploymentDescriptor(OutputStream deploymentDescriptorStream)

Write the (optional) deployment descriptor to the given OutputStream.

generateDBWSProvider

public void generateDBWSProvider(OutputStream sourceProviderStream,
 OutputStream classProviderStream,
 OutputStream sourceProviderListenerStream,
 OutputStream classProviderListenerStream)

writeSchema

public void writeSchema(OutputStream dbwsSchemaStream)

writeOROXProjects

public void writeOROXProjects(OutputStream dbwsOrStream,
 OutputStream dbwsOxStream)

getResultSetMetadataForSecondarySQL

protected static ResultSetMetaData getResultSetMetadataForSecondarySQL(Connection connection,
 String secondarySql)

Return a ResultSetMetaData instance for a given SQL statement.

setUpDirectToFieldMapping

protected static DirectToFieldMapping setUpDirectToFieldMapping(RelationalDescriptor desc,
 String columnName,
 NamingConventionTransformer nct,
 Class<?> attributeClass,
 int jdbcType,
 boolean isPk)

setUpXMLDirectMapping

protected XMLDirectMapping setUpXMLDirectMapping(String columnName,
 QName qName,
 NamingConventionTransformer nct,
 Class<?> attributeClass,
 int jdbcType,
 boolean isPk)

setUpCustomTransformer

protected NamingConventionTransformer setUpCustomTransformer(String tableName,
 NamingConventionTransformer nct)

setUpFindQueries

protected void setUpFindQueries(NamingConventionTransformer nct,
 String tableName,
 RelationalDescriptor desc)

Generates 'findByPrimaryKey' and 'findAll' queries for a given table and descriptor. The queries are set on the given descriptor.

buildDbColumns

protected static List<DbColumn> buildDbColumns(Connection connection,
 String secondarySql)

getTypeNameForDatabaseType

protected static String getTypeNameForDatabaseType(DatabaseType dataType)

Return the type name to be used for a given database type. The given DatabaseType's typeName attribute is typically returned, however, in some cases special handling may be required. For example, in the case of a NumericType instance, "DECIMAL" should be used for the type name.

buildDatabaseTypeFromMetadataType

protected DatabaseType buildDatabaseTypeFromMetadataType(DatabaseType dType)

Build a org.eclipse.persistence.internal.helper.DatabaseType instance from an org.eclipse.persistence.tools.oracleddl.metadata.DatabaseType instance.

buildDatabaseTypeFromMetadataType

protected DatabaseType buildDatabaseTypeFromMetadataType(DatabaseType dType,
 String catalog)

Build a org.eclipse.persistence.internal.helper.DatabaseType instance from an org.eclipse.persistence.tools.oracleddl.metadata.DatabaseType instance. In the the case of PLSQL Packages, the catalog (package) name can be passed in as well.

handleSimpleXMLFormat

protected void handleSimpleXMLFormat(boolean isSimpleXMLFormat,
 Result result,
 ProcedureOperationModel procedureOperationModel)

Apply SimpleXMLFormat if 'isSimpleXMLFormat' is true. The SimpleXMLFormat is configured based on the given ProcedureOperationModel's simpleXMLFormatTag and xmlTag (if set) and set on the given Result. A descriptor is also added to the OXProject if none exists.

finishProcedureOperation

protected void finishProcedureOperation()

Perform any additional actions required for operation creation for both PL/SQL and non-PL/SQL operation models.

getArgumentListForProcedureType

protected List<ArgumentType> getArgumentListForProcedureType(ProcedureType pType)

Return a list of ArgumentTypes for a given Procedure Type. This will include a return argument if pType is a FunctionType.

getWrapperClass

protected Class getWrapperClass(DatabaseType databaseType)

Return the wrapper class for a given DatabaseType. The class will be loaded by the XRDynamicClassloader, based on the DatabaseType's javaTypeName. If the class cannot be loaded, or the given DatabaseType is not a ComplexDatabaseType, null will be returned.

getWrapperClass

protected Class getWrapperClass(String wrapperClassName)

Return the wrapper class for a wrapper class name. The wrapper class name would typically be an argument type name, descriptor java class name, or a DatabaseType's javaTypeName. The class will be loaded by the XRDynamicClassloader; if the class cannot be loaded, null will be returned.

logNotFoundWarnings

protected void logNotFoundWarnings(String message,
 List<String> schemaPatterns,
 List<String> catalogPatterns,
 List<String> targetPatterns)

Log a WARNING with the DBWSBuilder when a target (table, package, stored procedure/function, etc) cannot be found using the information given by the user.

logPackageNotFoundWarnings

protected void logPackageNotFoundWarnings(String message,
 List<String> schemaPatterns,
 List<String> catalogPatterns)

Log a WARNING with the DBWSBuilder when a package cannot be found using the information given by the user.