Top Constructors Methods
org.apache.derby.impl.sql.compile

public Class UserDefinedTypeCompiler

extends BaseTypeCompiler
Class Inheritance
Imports
org.apache.derby.catalog.types.UserDefinedTypeIdImpl, org.apache.derby.shared.common.reference.ClassName, org.apache.derby.iapi.services.compiler.LocalField, .MethodBuilder, org.apache.derby.iapi.services.loader.ClassFactory, org.apache.derby.iapi.sql.compile.TypeCompiler, org.apache.derby.iapi.types.DataTypeDescriptor, .TypeId

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
compatible(TypeId
The CompilationType of the other type to compare this type to
otherType
)

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.compatible.

Determine if this type is compatible to some other type (e.g. COALESCE(thistype, othertype)).

public boolean

Returns:

true if otherType is convertible to this type, else false.
convertible
(TypeId otherType, boolean forDataTypeFunction)

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.convertible.

Right now, casting is not allowed from one user defined type to another.

public void
generateDataValue(MethodBuilder
The method to put the expression in
mb
,
int
For character DVDs, this will be used to determine what Collator should be associated with the DVD which in turn will decide whether to generate CollatorSQLcharDVDs or SQLcharDVDs. For other types of DVDs, this parameter will be ignored.
collationType
,
LocalField
LocalField
field
)

Overrides org.apache.derby.impl.sql.compile.BaseTypeCompiler.generateDataValue.

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.generateDataValue.

The caller will have pushed a DataValueFactory and value of that can be converted to the correct type, e.g. int for a SQL INTEGER.

public int
getCastToCharWidth(DataTypeDescriptor
The associated DataTypeDescriptor for this TypeId.
dts
)

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.getCastToCharWidth.

Return the maximum width for this data type when cast to a char type.

public String
public String
interfaceName()

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.interfaceName.

Get the name of the interface for this type.

pack-priv String
nullMethodName()

Implements abstract org.apache.derby.impl.sql.compile.BaseTypeCompiler.nullMethodName.

Return the method name to get a Derby DataValueDescriptor object of the correct type set to SQL NULL.

public boolean

Returns:

true if otherType is storable into this type, else false.
storable
(TypeId
the type of the instance to store into this type.
otherType
,
ClassFactory
A ClassFactory
cf
)

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.storable.

ANSI UDTs can only be stored into values of exactly their own type.

Inherited from org.apache.derby.impl.sql.compile.BaseTypeCompiler:
dataValueMethodNamegenerateNullgetPrimitiveMethodNamegetStoredFormatIdFromTypeIdgetTypeCompilergetTypeIdnumberConvertiblenumberStorablepushCollationForDataValueresolveArithmeticOperationsetTypeIduserTypeStorable

Constructor Detail

UserDefinedTypeCompilerback to summary
public UserDefinedTypeCompiler()

Method Detail

compatibleback to summary
public boolean compatible(TypeId otherType)

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.compatible.

Doc from org.apache.derby.iapi.sql.compile.TypeCompiler.compatible.

Determine if this type is compatible to some other type (e.g. COALESCE(thistype, othertype)).

Parameters
otherType:TypeId

The CompilationType of the other type to compare this type to

Returns:boolean

true if the types are compatible, false if not compatible

See Also
TypeCompiler#compatible
convertibleback to summary
public boolean convertible(TypeId otherType, boolean forDataTypeFunction)

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.convertible.

Right now, casting is not allowed from one user defined type to another.

Returns:boolean

true if otherType is convertible to this type, else false.

See Also
TypeCompiler#convertible
generateDataValueback to summary
public void generateDataValue(MethodBuilder mb, int collationType, LocalField field)

Overrides org.apache.derby.impl.sql.compile.BaseTypeCompiler.generateDataValue.

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.generateDataValue.

Doc from org.apache.derby.impl.sql.compile.BaseTypeCompiler.generateDataValue.

The caller will have pushed a DataValueFactory and value of that can be converted to the correct type, e.g. int for a SQL INTEGER. Thus upon entry the stack looks like: ...,dvf,value If field is not null then it is used as the holder of the generated DataValueDescriptor to avoid object creations on multiple passes through this code. The field may contain null or a valid value. This method then sets up to call the required method on DataValueFactory using the dataValueMethodName(). The value left on the stack will be a DataValueDescriptor of the correct type: If the field contained a valid value then generated code will return that value rather than a newly created object. If field was not-null then the generated code will set the value of field to be the return from the DataValueFactory method call. Thus if the field was empty (set to null) when this code is executed it will contain the newly generated value, otherwise it will be reset to the same value. ...,dvd

Parameters
mb:MethodBuilder

Doc from org.apache.derby.iapi.sql.compile.TypeCompiler.generateDataValue.

The method to put the expression in

collationType:int

Doc from org.apache.derby.iapi.sql.compile.TypeCompiler.generateDataValue.

For character DVDs, this will be used to determine what Collator should be associated with the DVD which in turn will decide whether to generate CollatorSQLcharDVDs or SQLcharDVDs. For other types of DVDs, this parameter will be ignored.

field:LocalField

Doc from org.apache.derby.iapi.sql.compile.TypeCompiler.generateDataValue.

LocalField

Annotations
@Override
getCastToCharWidthback to summary
public int getCastToCharWidth(DataTypeDescriptor dts)

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.getCastToCharWidth.

Doc from org.apache.derby.iapi.sql.compile.TypeCompiler.getCastToCharWidth.

Return the maximum width for this data type when cast to a char type.

Parameters
dts:DataTypeDescriptor

The associated DataTypeDescriptor for this TypeId.

Returns:int

int The maximum width for this data type when cast to a char type.

See Also
TypeCompiler#getCastToCharWidth
getCorrespondingPrimitiveTypeNameback to summary
public String getCorrespondingPrimitiveTypeName()

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.getCorrespondingPrimitiveTypeName.

Doc from org.apache.derby.iapi.sql.compile.TypeCompiler.getCorrespondingPrimitiveTypeName.

Get the name of the corresponding Java type. For numerics and booleans we will get the corresponding Java primitive type. e Each SQL type has a corresponding Java type. When a SQL value is passed to a Java method, it is translated to its corresponding Java type. For example, a SQL Integer will be mapped to a Java int, but a SQL date will be mapped to a java.sql.Date.

Returns:String

The name of the corresponding Java primitive type.

See Also
TypeCompiler#getCorrespondingPrimitiveTypeName
interfaceNameback to summary
public String interfaceName()

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.interfaceName.

Doc from org.apache.derby.iapi.sql.compile.TypeCompiler.interfaceName.

Get the name of the interface for this type. For example, the interface for a SQLInteger is NumberDataValue. The full path name of the type is returned.

Returns:String

The name of the interface for this type.

See Also
TypeCompiler#interfaceName
nullMethodNameback to summary
pack-priv String nullMethodName()

Implements abstract org.apache.derby.impl.sql.compile.BaseTypeCompiler.nullMethodName.

Doc from org.apache.derby.impl.sql.compile.BaseTypeCompiler.nullMethodName.

Return the method name to get a Derby DataValueDescriptor object of the correct type set to SQL NULL. The method named will be called with one argument: a holder object if pushCollationForDataValue() returns false, otherwise two arguments, the second being the collationType.

storableback to summary
public boolean storable(TypeId otherType, ClassFactory cf)

Implements org.apache.derby.iapi.sql.compile.TypeCompiler.storable.

ANSI UDTs can only be stored into values of exactly their own type. This restriction can be lifted when we implement the ANSI subclassing clauses. Old-style User types are storable into other user types that they are assignable to. The other type must be a subclass of this type, or implement this type as one of its interfaces.

Parameters
otherType:TypeId

the type of the instance to store into this type.

cf:ClassFactory

A ClassFactory

Returns:boolean

true if otherType is storable into this type, else false.