EclipseLink 1.1.4, build 'v20100812-r7860' API Reference

org.eclipse.persistence.tools.schemaframework
Class VarrayDefinition

java.lang.Object
  extended by org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
      extended by org.eclipse.persistence.tools.schemaframework.VarrayDefinition
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
ObjectVarrayDefinition

public class VarrayDefinition
extends DatabaseObjectDefinition

Purpose: Allow for creation of varray type.

See Also:
Serialized Form

Field Summary
protected  int size
           
protected  java.lang.Class type
           
protected  java.lang.String typeName
           
protected  int typeSize
           
 
Fields inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
name, qualifier
 
Constructor Summary
VarrayDefinition()
           
 
Method Summary
 void appendTypeString(java.io.Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session)
          INTERNAL: Append the type.
 java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
          INTERNAL: Return the DDL to create the varray.
 java.io.Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
          INTERNAL: Return the DDL to drop the varray.
 int getSize()
          PUBLIC: Return the maximum size of the array.
 java.lang.Class getType()
          PUBLIC: Return the type of the field.
 java.lang.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(java.lang.Class type)
          PUBLIC: Set the type of the field.
 void setTypeName(java.lang.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
clone, createObject, createOnDatabase, dropFromDatabase, dropObject, getFullName, getName, getQualifier, setName, setQualifier, 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 java.lang.Class type

typeName

protected java.lang.String typeName
Constructor Detail

VarrayDefinition

public VarrayDefinition()
Method Detail

appendTypeString

public void appendTypeString(java.io.Writer writer,
                             org.eclipse.persistence.internal.sessions.AbstractSession session)
                      throws ValidationException
INTERNAL: Append the type.

Throws:
ValidationException

buildCreationWriter

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

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 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 java.lang.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 java.lang.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(java.lang.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(java.lang.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.


EclipseLink 1.1.4, build 'v20100812-r7860' API Reference