Module org.eclipse.persistence.dbws.builder

Package org.eclipse.persistence.tools.metadata.generation

Class Util

java.lang.Object

org.eclipse.persistence.tools.metadata.generation.Util

public class Util
extends Object

Utility class typically used when constructing JPA/JAXB metadata from a list of meta-model database types.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	_TYPE_STR
static final String	ALL_QUERYNAME
static final String	AND_STR
static final String	ARRAY_CLS_STR
static final String	ARRAY_STR
static final String	BIGINT_STR
static final String	BINARY_INTEGER_STR
static final String	BINARY_INTEGER_TYPE_STR
static final String	BINARY_STR
static final String	BLOB_STR
static final String	BOOLEAN_STR
static final String	CHAR_STR
static final String	CLOB_STR
static final String	CLOSE_BRACKET
static final String	COMMA
static final String	COMMA_SPACE_STR
static final String	CREATE_OPERATION_NAME
static final String	DATE_STR
static final String	DECIMAL_STR
static final String	DELETE_STR
static final String	DOT
static final String	DOUBLE_STR
static final String	EQUALS_BINDING_STR
static final String	EQUALS_BINDING1_STR
static final String	FLOAT_STR
static final String	INSERT_STR
static final String	INTEGER_STR
static final String	ITEMS_COL_STR
static final String	ITEMS_FLD_STR
static final String	LONG_STR
static final String	LONGRAW_STR
static final String	LONGVARBINARY_STR
static final String	NATURAL_STR
static final String	NATURAL_TYPE_STR
static final String	NCHAR_STR
static final String	NCLOB_CLS_STR
static final String	NCLOB_STR
static final String	NUMBER_STR
static final String	NUMERIC_STR
static final String	NVARCHAR_STR
static final String	NVARCHAR2_STR
static final int	OPAQUE
static final String	OPAQUE_CLS_STR
static final String	OPEN_BRACKET
static final String	ORACLE_TIMESTAMP_CLS_STR
static final String	OTHER_STR
static final String	PERCENT
static final String	PK_QUERYNAME
static final String	PLS_BOOLEAN_TYPE_STR
static final String	PLS_INTEGER_STR
static final String	PLS_INTEGER_TYPE_STR
static final String	POSITIVE_STR
static final String	POSITIVE_TYPE_STR
static final String	QUESTION_STR
static final String	RAW_STR
static final String	REAL_STR
static final String	REMOVE_OPERATION_NAME
static final String	ROWID_CLS_STR
static final String	ROWID_STR
static final String	ROWTYPE_STR
static final String	SELECT_FROM_STR
static final String	SET_STR
static final String	SIGNTYPE_STR
static final String	SIGNTYPE_TYPE_STR
static final String	SINGLE_SPACE
static final String	SMALLINT_STR
static final String	STRUCT_CLS_STR
static final String	STRUCT_STR
static final String	SYS_XMLTYPE_STR
static final String	TIME_STR
static final String	TIMESTAMP_STR
static final String	TINYINT_STR
static final String	TYPE_STR
static final String	UNDERSCORE
static final String	UPDATE_OPERATION_NAME
static final String	UPDATE_STR
static final String	UROWID_STR
static final String	VALUES_STR
static final String	VARBINARY_STR
static final String	VARCHAR_STR
static final String	VARCHAR2_STR
static final String	WHERE_STR
static final String	XMLTYPE_STR

Constructor Summary

Constructors

Constructor	Description
Util()

Method Summary

Modifier and Type	Method	Description
protected static String	getAttributeTypeNameForFieldType(FieldType fldType, DatabasePlatform dbPlatform)	Return the attribute-type name for a given FieldType.
static Class<?>	getClassFromJDBCTypeName(String typeName, DatabasePlatform databasePlatform)	Return the Class for a given type name using the provided DatabasePlatform.
static String	getClassNameFromJDBCTypeName(String typeName, DatabasePlatform databasePlatform)	Return the Class name for a given type name using the provided DatabasePlatform.
static String	getEntityName(String tableName, String packageName)	Returns a entity class name based on a given table or type name.
static String	getGeneratedJavaClassName(String name)	Returns a Java class name based on a given qualified name.
static String	getGeneratedJavaClassName(String name, String packageName)	Returns a Java class name based on a given name and package.
static int	getJDBCTypeFromTypeName(String typeName)	Return the JDBC type (as int) for a given type name.
static String	getJDBCTypeName(String typeName)	Return the JDBC type name for a given type String.
static String	getJDBCTypeNameFromType(int jdbcType)	Return the JDBC type name for a given JDBC type code.
static String	getOraclePLSQLTypeForName(String typeName)	Return the Oracle PL/SQL name for a given PL/SQL scalar type.
static String	getQualifiedCompatibleTypeName(DatabaseType dbType)	Return a qualified compatible type name for the given DatabaseType.
static String	getQualifiedTypeName(DatabaseType dbType)	Return a qualified type name for the given DatabaseType.
protected static String	getTypeNameForDatabaseType(DatabaseType dataType)	Return the type name to be used for a given database type.
static String	getUnqualifiedEntityName(String tableName)	Returns a unqualified entity class name based on a given table or type name.
protected static void	handleOverloading(List<ProcedureType> procedures)	Convenience method that detects multiple procedures with the same procedure name, and updates the overload value on the relevant ProcedureTypes accordingly.
static boolean	isArgPLSQLScalar(String argTypeName)	Indicates if a given argument type name is considered a PL/SQL scalar argument, i.e.
protected static String	processTypeName(String typeName)	Alter the given type name if required.

Methods inherited from class java.lang.Object

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

Field Details

ARRAY_STR

public static final String ARRAY_STR

See Also:

• Constant Field Values

BIGINT_STR

public static final String BIGINT_STR

See Also:

• Constant Field Values

BINARY_STR

public static final String BINARY_STR

See Also:

• Constant Field Values

BLOB_STR

public static final String BLOB_STR

See Also:

• Constant Field Values

BOOLEAN_STR

public static final String BOOLEAN_STR

See Also:

• Constant Field Values

CHAR_STR

public static final String CHAR_STR

See Also:

• Constant Field Values

CLOB_STR

public static final String CLOB_STR

See Also:

• Constant Field Values

DATE_STR

public static final String DATE_STR

See Also:

• Constant Field Values

DECIMAL_STR

public static final String DECIMAL_STR

See Also:

• Constant Field Values

DOUBLE_STR

public static final String DOUBLE_STR

See Also:

• Constant Field Values

FLOAT_STR

public static final String FLOAT_STR

See Also:

• Constant Field Values

INTEGER_STR

public static final String INTEGER_STR

See Also:

• Constant Field Values

LONG_STR

public static final String LONG_STR

See Also:

• Constant Field Values

LONGRAW_STR

public static final String LONGRAW_STR

See Also:

• Constant Field Values

LONGVARBINARY_STR

public static final String LONGVARBINARY_STR

See Also:

• Constant Field Values

NCHAR_STR

public static final String NCHAR_STR

See Also:

• Constant Field Values

NCLOB_STR

public static final String NCLOB_STR

See Also:

• Constant Field Values

NUMBER_STR

public static final String NUMBER_STR

See Also:

• Constant Field Values

NUMERIC_STR

public static final String NUMERIC_STR

See Also:

• Constant Field Values

NVARCHAR_STR

public static final String NVARCHAR_STR

See Also:

• Constant Field Values

NVARCHAR2_STR

public static final String NVARCHAR2_STR

See Also:

• Constant Field Values

OTHER_STR

public static final String OTHER_STR

See Also:

• Constant Field Values

RAW_STR

public static final String RAW_STR

See Also:

• Constant Field Values

REAL_STR

public static final String REAL_STR

See Also:

• Constant Field Values

ROWID_STR

public static final String ROWID_STR

See Also:

• Constant Field Values

ROWTYPE_STR

public static final String ROWTYPE_STR

See Also:

• Constant Field Values

SMALLINT_STR

public static final String SMALLINT_STR

See Also:

• Constant Field Values

STRUCT_STR

public static final String STRUCT_STR

See Also:

• Constant Field Values

TIME_STR

public static final String TIME_STR

See Also:

• Constant Field Values

TIMESTAMP_STR

public static final String TIMESTAMP_STR

See Also:

• Constant Field Values

TINYINT_STR

public static final String TINYINT_STR

See Also:

• Constant Field Values

UROWID_STR

public static final String UROWID_STR

See Also:

• Constant Field Values

VARBINARY_STR

public static final String VARBINARY_STR

See Also:

• Constant Field Values

VARCHAR_STR

public static final String VARCHAR_STR

See Also:

• Constant Field Values

VARCHAR2_STR

public static final String VARCHAR2_STR

See Also:

• Constant Field Values

BINARY_INTEGER_STR

public static final String BINARY_INTEGER_STR

See Also:

• Constant Field Values

PLS_INTEGER_STR

public static final String PLS_INTEGER_STR

See Also:

• Constant Field Values

NATURAL_STR

public static final String NATURAL_STR

See Also:

• Constant Field Values

POSITIVE_STR

public static final String POSITIVE_STR

See Also:

• Constant Field Values

SIGNTYPE_STR

public static final String SIGNTYPE_STR

See Also:

• Constant Field Values

BINARY_INTEGER_TYPE_STR

public static final String BINARY_INTEGER_TYPE_STR

See Also:

• Constant Field Values

PLS_BOOLEAN_TYPE_STR

public static final String PLS_BOOLEAN_TYPE_STR

See Also:

• Constant Field Values

PLS_INTEGER_TYPE_STR

public static final String PLS_INTEGER_TYPE_STR

See Also:

• Constant Field Values

NATURAL_TYPE_STR

public static final String NATURAL_TYPE_STR

See Also:

• Constant Field Values

POSITIVE_TYPE_STR

public static final String POSITIVE_TYPE_STR

See Also:

• Constant Field Values

SIGNTYPE_TYPE_STR

public static final String SIGNTYPE_TYPE_STR

See Also:

• Constant Field Values

SYS_XMLTYPE_STR

public static final String SYS_XMLTYPE_STR

See Also:

• Constant Field Values

XMLTYPE_STR

public static final String XMLTYPE_STR

See Also:

• Constant Field Values

_TYPE_STR

public static final String _TYPE_STR

See Also:

• Constant Field Values

COMMA

public static final String COMMA

See Also:

• Constant Field Values

SINGLE_SPACE

public static final String SINGLE_SPACE

See Also:

• Constant Field Values

COMMA_SPACE_STR

public static final String COMMA_SPACE_STR

See Also:

• Constant Field Values

ALL_QUERYNAME

public static final String ALL_QUERYNAME

See Also:

• Constant Field Values

PK_QUERYNAME

public static final String PK_QUERYNAME

See Also:

• Constant Field Values

CREATE_OPERATION_NAME

public static final String CREATE_OPERATION_NAME

See Also:

• Constant Field Values

UPDATE_OPERATION_NAME

public static final String UPDATE_OPERATION_NAME

See Also:

• Constant Field Values

REMOVE_OPERATION_NAME

public static final String REMOVE_OPERATION_NAME

See Also:

• Constant Field Values

OPEN_BRACKET

public static final String OPEN_BRACKET

See Also:

• Constant Field Values

CLOSE_BRACKET

public static final String CLOSE_BRACKET

See Also:

• Constant Field Values

TYPE_STR

public static final String TYPE_STR

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

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

QUESTION_STR

public static final String QUESTION_STR

See Also:

• Constant Field Values

ARRAY_CLS_STR

public static final String ARRAY_CLS_STR

See Also:

• Constant Field Values

NCLOB_CLS_STR

public static final String NCLOB_CLS_STR

See Also:

• Constant Field Values

OPAQUE_CLS_STR

public static final String OPAQUE_CLS_STR

See Also:

• Constant Field Values

ROWID_CLS_STR

public static final String ROWID_CLS_STR

See Also:

• Constant Field Values

STRUCT_CLS_STR

public static final String STRUCT_CLS_STR

See Also:

• Constant Field Values

ORACLE_TIMESTAMP_CLS_STR

public static final String ORACLE_TIMESTAMP_CLS_STR

See Also:

• Constant Field Values

DOT

public static final String DOT

See Also:

• Constant Field Values

PERCENT

public static final String PERCENT

See Also:

• Constant Field Values

UNDERSCORE

public static final String UNDERSCORE

See Also:

• Constant Field Values

ITEMS_FLD_STR

public static final String ITEMS_FLD_STR

See Also:

• Constant Field Values

ITEMS_COL_STR

public static final String ITEMS_COL_STR

See Also:

• Constant Field Values

OPAQUE

public static final int OPAQUE

See Also:

• Constant Field Values

Constructor Details

Util

public Util()

Method Details

getUnqualifiedEntityName

public static String getUnqualifiedEntityName(String tableName)

Returns a unqualified entity class name based on a given table or type name. The returned string will contain an upper case first char, with the remaining chars in lower case format.

getEntityName

public static String getEntityName(String tableName,
 String packageName)

Returns a entity class name based on a given table or type name. The returned string will contain an upper case first char, with the remaining chars in lower case format. The packageName will be prepended to the Entity name if non-null.

getJDBCTypeName

public static String getJDBCTypeName(String typeName)

Return the JDBC type name for a given type String.

getJDBCTypeFromTypeName

public static int getJDBCTypeFromTypeName(String typeName)

Return the JDBC type (as int) for a given type name.

getJDBCTypeNameFromType

public static String getJDBCTypeNameFromType(int jdbcType)

Return the JDBC type name for a given JDBC type code.

getClassNameFromJDBCTypeName

public static String getClassNameFromJDBCTypeName(String typeName,
 DatabasePlatform databasePlatform)

Return the Class name for a given type name using the provided DatabasePlatform. Object.class.getName() will be returned if the DatabasePlatform returns null.

getClassFromJDBCTypeName

public static Class<?> getClassFromJDBCTypeName(String typeName,
 DatabasePlatform databasePlatform)

Return the Class for a given type name using the provided DatabasePlatform. Object.class will be returned if the DatabasePlatform returns null.

processTypeName

protected static String processTypeName(String typeName)

Alter the given type name if required.

getGeneratedJavaClassName

public static String getGeneratedJavaClassName(String name)

Returns a Java class name based on a given qualified name. If the name has a package prepended to it, the the returned string will be in the format 'packagename.Name', otherwise the format will be 'Name'. For example, given the name 'test.EMPLOYEE', the method would return the string 'test.Employee'.

getGeneratedJavaClassName

public static String getGeneratedJavaClassName(String name,
 String packageName)

Returns a Java class name based on a given name and package. The returned string will be in the format 'packagename.Name'. For example, given the name 'EMPLOYEE' and packageName 'TEST', the method would return the string 'test.Employee'.

getQualifiedTypeName

public static String getQualifiedTypeName(DatabaseType dbType)

Return a qualified type name for the given DatabaseType. If the type is a PLSQLType or a PLSQLCursor, and there is a package name available on the type's parent, a string will be returned in the format 'package.typename'. Otherwise the type name will be returned.

getQualifiedCompatibleTypeName

public static String getQualifiedCompatibleTypeName(DatabaseType dbType)

Return a qualified compatible type name for the given DatabaseType. If the type is a PLSQLType, and there is a package name available on the type's parent, a string will be returned in the format 'package_typename'. Otherwise the type name will be returned. A compatible type is the JDBC type equivalent of a PL/SQL type.

isArgPLSQLScalar

public static boolean isArgPLSQLScalar(String argTypeName)

Indicates if a given argument type name is considered a PL/SQL scalar argument, i.e. is one of BOOLEAN, BINARY_INTEGER, PLS_INTEGER, etc.

getOraclePLSQLTypeForName

public static String getOraclePLSQLTypeForName(String typeName)

Return the Oracle PL/SQL name for a given PL/SQL scalar type.

getAttributeTypeNameForFieldType

protected static String getAttributeTypeNameForFieldType(FieldType fldType,
 DatabasePlatform dbPlatform)

Return the attribute-type name for a given FieldType. For CHAR sized type, java.lang.Character will be returned. For CHAR non-sized type, java.lang.String will be returned. For non-CHAR type, the database platform will be used to get the type name. If the type to be returned is oracle.sql.Timestamp, java.sql.Timestamp will be returned instead (to handle conversion issue with Oracle11Platform)

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.

handleOverloading

protected static void handleOverloading(List<ProcedureType> procedures)

Convenience method that detects multiple procedures with the same procedure name, and updates the overload value on the relevant ProcedureTypes accordingly. The first ProcedureType will have an overload value of 0, the second 1, and so on.