org.eclipse.persistence.tools.schemaframework

Class VarrayDefinition

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.VarrayDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ObjectVarrayDefinition

public class VarrayDefinition
extends DatabaseObjectDefinition

Purpose: Allow for creation of varray type.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	size
protected Class	type
protected String	typeName
protected int	typeSize

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

name, qualifier

Constructor Summary

Constructors

Constructor and Description
VarrayDefinition()

Method Summary

Modifier and Type	Method and Description
void	appendTypeString(Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Append the type.
Writer	buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer) INTERNAL: Return the DDL to create the VARRAY.
Writer	buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer) INTERNAL: Return the DDL to drop the varray.
int	getSize() PUBLIC: Return the maximum size of the array.
Class	getType() PUBLIC: Return the type of the field.
String	getTypeName() PUBLIC: Return the type of the field.
int	getTypeSize() PUBLIC: Return the size of the element field, this is only required for some field types.
void	setSize(int size) PUBLIC: Set the maximum size of the array.
void	setType(Class type) PUBLIC: Set the type of the field.
void	setTypeName(String typeName) PUBLIC: Set the type of the field.
void	setTypeSize(int typeSize) PUBLIC: Set the size of the element field, this is only required for some field types.

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

typeSize

protected int typeSize

size

protected int size

type

protected Class type

typeName

protected String typeName

Constructor Detail

VarrayDefinition

public VarrayDefinition()

Method Detail

appendTypeString

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

INTERNAL: Append the type.

Parameters:

writer - Target writer where to write type string.

session - Current session context.

Throws:

ValidationException - When invalid or inconsistent data were found.

buildCreationWriter

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

INTERNAL: Return the DDL to create the VARRAY.

Specified by:

buildCreationWriter in class DatabaseObjectDefinition

Parameters:

writer - Target writer.

session - Current session context.

Returns:

Target writer with CREATE TYPE ... AS VARRAY (...) OF ... already written to it.

Throws:

ValidationException - When invalid or inconsistent data were found.

buildDeletionWriter

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

INTERNAL: Return the DDL to drop the varray.

Specified by:

buildDeletionWriter in class DatabaseObjectDefinition

Throws:

ValidationException

getSize

public int getSize()

PUBLIC: Return the maximum size of the array.

getType

public Class getType()

PUBLIC: Return the type of the field. This should be set to a java class, such as String.class, Integer.class or Date.class.

getTypeName

public String getTypeName()

PUBLIC: Return the type of the field. This is the exact DB type name, which can be used instead of the Java class.

getTypeSize

public int getTypeSize()

PUBLIC: Return the size of the element field, this is only required for some field types.

setSize

public void setSize(int size)

PUBLIC: Set the maximum size of the array.

setType

public void setType(Class type)

PUBLIC: Set the type of the field. This should be set to a java class, such as String.class, Integer.class or Date.class.

setTypeName

public void setTypeName(String typeName)

PUBLIC: Set the type of the field. This is the exact DB type name, which can be used instead of the Java class.

setTypeSize

public void setTypeSize(int typeSize)

PUBLIC: Set the size of the element field, this is only required for some field types.