org.apache.cayenne.access.types
Class EnumType

java.lang.Object
  extended by org.apache.cayenne.access.types.EnumType
All Implemented Interfaces:
ExtendedType

public class EnumType
extends java.lang.Object
implements ExtendedType

An ExtendedType that handles an enum class. If Enum is mapped to a character column, its name is used as persistent value; if it is mapped to a numeric column, its ordinal (i.e. a position in enum class) is used.

Requires Java 1.5 or newer

Since:
1.2
Author:
Andrus Adamchik

Field Summary
protected  java.lang.Class enumClass
           
protected  java.lang.Object[] values
           
 
Constructor Summary
EnumType(java.lang.Class enumClass)
           
 
Method Summary
 java.lang.String getClassName()
          Returns a full name of Java class that this ExtendedType supports.
 java.lang.Object materializeObject(java.sql.CallableStatement rs, int index, int type)
          Reads an object from a stored procedure OUT parameter, converting it to class returned by 'getClassName' method.
 java.lang.Object materializeObject(java.sql.ResultSet rs, int index, int type)
          Reads an object from JDBC ResultSet column, converting it to class returned by 'getClassName' method.
 void setJdbcObject(java.sql.PreparedStatement statement, java.lang.Object value, int pos, int type, int precision)
          Initializes a single parameter of a PreparedStatement with object value.
 boolean validateProperty(java.lang.Object source, java.lang.String property, java.lang.Object value, DbAttribute dbAttribute, ValidationResult validationResult)
          Performs validation of an object property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

enumClass

protected java.lang.Class enumClass

values

protected java.lang.Object[] values
Constructor Detail

EnumType

public EnumType(java.lang.Class enumClass)
Method Detail

getClassName

public java.lang.String getClassName()
Description copied from interface: ExtendedType
Returns a full name of Java class that this ExtendedType supports.

Specified by:
getClassName in interface ExtendedType

validateProperty

public boolean validateProperty(java.lang.Object source,
                                java.lang.String property,
                                java.lang.Object value,
                                DbAttribute dbAttribute,
                                ValidationResult validationResult)
Description copied from interface: ExtendedType
Performs validation of an object property. Property is considered valid if this it satisfies the database constraints known to this ExtendedType. In case of validation failure, failures are appended to the ValidationResult object and false is returned.

Specified by:
validateProperty in interface ExtendedType

setJdbcObject

public void setJdbcObject(java.sql.PreparedStatement statement,
                          java.lang.Object value,
                          int pos,
                          int type,
                          int precision)
                   throws java.lang.Exception
Description copied from interface: ExtendedType
Initializes a single parameter of a PreparedStatement with object value.

Specified by:
setJdbcObject in interface ExtendedType
Throws:
java.lang.Exception

materializeObject

public java.lang.Object materializeObject(java.sql.ResultSet rs,
                                          int index,
                                          int type)
                                   throws java.lang.Exception
Description copied from interface: ExtendedType
Reads an object from JDBC ResultSet column, converting it to class returned by 'getClassName' method.

Specified by:
materializeObject in interface ExtendedType
Throws:
java.lang.Exception - if read error ocurred, or an object can't be converted to a target Java class.

materializeObject

public java.lang.Object materializeObject(java.sql.CallableStatement rs,
                                          int index,
                                          int type)
                                   throws java.lang.Exception
Description copied from interface: ExtendedType
Reads an object from a stored procedure OUT parameter, converting it to class returned by 'getClassName' method.

Specified by:
materializeObject in interface ExtendedType
Throws:
java.lang.Exception - if read error ocurred, or an object can't be converted to a target Java class.


Copyright © 2001-2006 Apache.org All Rights Reserved.