Module eclipselink

Package org.eclipse.persistence.tools.schemaframework

Class TypeDefinition

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.TypeDefinition

All Implemented Interfaces:

Serializable, 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

Fields

Modifier and Type	Field	Description
protected List<FieldDefinition>	fields

Fields inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

name, qualifier

Constructor Summary

Constructors

Constructor	Description
TypeDefinition()

Method Summary

Modifier and Type	Method	Description
void	addField(String fieldName, Class<?> type)	PUBLIC: Add the field to the type, default sizes are used.
void	addField(String fieldName, Class<?> type, int fieldSize)	PUBLIC: Add the field to the type.
void	addField(String fieldName, Class<?> type, int fieldSize, int fieldSubSize)	PUBLIC: Add the field to the type.
void	addField(String fieldName, String typeName)	PUBLIC: Add the field to the type to a nested type.
void	addField(FieldDefinition field)	PUBLIC: Add the field to the type.
Writer	buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer)	INTERNAL: Return the create type statement.
Writer	buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer)	INTERNAL: Return the drop type statement.
List<FieldDefinition>	getFields()
void	setFields(List<FieldDefinition> fields)

Methods inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

buildVPDCreationFunctionWriter, buildVPDCreationPolicyWriter, buildVPDDeletionWriter, clone, createDatabaseSchema, createDatabaseSchemaOnDatabase, createObject, createOnDatabase, dropDatabaseSchema, dropDatabaseSchemaOnDatabase, dropFromDatabase, dropObject, getDatabaseSchema, getFieldTypeDefinition, getFieldTypeDefinition, getFullName, getName, getQualifier, hasDatabaseSchema, postCreateObject, preDropObject, setName, setQualifier, shouldCreateDatabaseSchema, shouldCreateVPDCalls, toString

Methods inherited from class java.lang.Object

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

Field Detail

fields

protected List<FieldDefinition> fields

Constructor Detail

TypeDefinition

public TypeDefinition()

Method Detail

addField

public void addField(String fieldName,
                     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(String fieldName,
                     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(String fieldName,
                     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(String fieldName,
                     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 Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                  Writer writer)
                           throws ValidationException

INTERNAL: Return the create type statement.

Specified by:

buildCreationWriter in class DatabaseObjectDefinition

Throws:

ValidationException

buildDeletionWriter

public Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                  Writer writer)
                           throws ValidationException

INTERNAL: Return the drop type statement.

Specified by:

buildDeletionWriter in class DatabaseObjectDefinition

Throws:

ValidationException

getFields

public List<FieldDefinition> getFields()

setFields

public void setFields(List<FieldDefinition> fields)