VarrayDefinition (EclipseLink 2.6.1, API Reference)

java.lang.Object
- org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
- - 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

Fields
Modifier and Type Field and Description

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

Fields
Modifier and Type	Field and Description
`protected int`	`size`
`protected java.lang.Class`	`type`
`protected java.lang.String`	`typeName`
`protected int`	`typeSize`

Constructor Summary

Constructors
Constructor and Description

VarrayDefinition()

Constructors
Constructor and Description
`VarrayDefinition()`

Method Summary

Methods
Modifier and Type	Method and Description
`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
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 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.
    
    Parameters:
    writer - Target writer where to write type string.
    session - Current session context.
    
    Throws:
    
    ValidationException - When invalid or inconsistent data were found.
  - 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
    
    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 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.

Class VarrayDefinition

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

typeSize

size

type

typeName

Constructor Detail

VarrayDefinition

Method Detail

appendTypeString

buildCreationWriter

buildDeletionWriter

getSize

getType

getTypeName

getTypeSize

setSize

setType

setTypeName

setTypeSize