EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

org.eclipse.persistence.tools.schemaframework
Class TypeDefinition

java.lang.Object
  extended by org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
      extended by org.eclipse.persistence.tools.schemaframework.TypeDefinition
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class TypeDefinition
extends DatabaseObjectDefinition

Purpose: Allow for Oracle 8 object-relational user defined type to be created.

See Also:
Serialized Form

Field Summary
protected  java.util.Vector fields
           
 
Fields inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
name, qualifier
 
Constructor Summary
TypeDefinition()
           
 
Method Summary
 void addField(FieldDefinition field)
          PUBLIC: Add the field to the type.
 void addField(java.lang.String fieldName, java.lang.Class type)
          PUBLIC: Add the field to the type, default sizes are used.
 void addField(java.lang.String fieldName, java.lang.Class type, int fieldSize)
          PUBLIC: Add the field to the type.
 void addField(java.lang.String fieldName, java.lang.Class type, int fieldSize, int fieldSubSize)
          PUBLIC: Add the field to the type.
 void addField(java.lang.String fieldName, java.lang.String typeName)
          PUBLIC: Add the field to the type to a nested type.
 java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
          INTERNAL: Return the create type statement.
 java.io.Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
          INTERNAL: Return the drop type statement.
 java.util.Vector getFields()
           
 void setFields(java.util.Vector fields)
           
 
Methods inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
clone, createObject, createOnDatabase, dropFromDatabase, dropObject, getFullName, getName, getQualifier, postCreateObject, preDropObject, setName, setQualifier, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

fields

protected java.util.Vector fields
Constructor Detail

TypeDefinition

public TypeDefinition()
Method Detail

addField

public void addField(java.lang.String fieldName,
                     java.lang.Class type)
PUBLIC: Add the field to the type, default sizes are used.

Parameters:
type - is the Java class type coresponding to the database type.

addField

public void addField(java.lang.String fieldName,
                     java.lang.Class type,
                     int fieldSize)
PUBLIC: Add the field to the type.

Parameters:
type - is the Java class type coresponding to the database type.

addField

public void addField(java.lang.String fieldName,
                     java.lang.Class type,
                     int fieldSize,
                     int fieldSubSize)
PUBLIC: Add the field to the type.

Parameters:
type - is the Java class type coresponding to the database type.

addField

public void addField(java.lang.String fieldName,
                     java.lang.String typeName)
PUBLIC: Add the field to the type to a nested type.

Parameters:
typeName - is the name of the nested type.

addField

public void addField(FieldDefinition field)
PUBLIC: Add the field to the type.


buildCreationWriter

public java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                          java.io.Writer writer)
                                   throws ValidationException
INTERNAL: Return the create type statement.

Specified by:
buildCreationWriter in class DatabaseObjectDefinition
Throws:
ValidationException

buildDeletionWriter

public java.io.Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                          java.io.Writer writer)
                                   throws ValidationException
INTERNAL: Return the drop type statement.

Specified by:
buildDeletionWriter in class DatabaseObjectDefinition
Throws:
ValidationException

getFields

public java.util.Vector getFields()

setFields

public void setFields(java.util.Vector fields)

EclipseLink 2.2.0, build 'v20110202-r8913' API Reference