org.h2.engine
Class UserAggregate

java.lang.Object
  org.h2.engine.DbObjectBase
      org.h2.engine.UserAggregate

All Implemented Interfaces:

DbObject

public class UserAggregate
extends DbObjectBase

Represents a user-defined aggregate function.

Field Summary

Fields inherited from class org.h2.engine.DbObjectBase

comment, database, trace

Fields inherited from interface org.h2.engine.DbObject

AGGREGATE, COMMENT, CONSTANT, CONSTRAINT, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, TABLE_OR_VIEW, TRIGGER, USER, USER_DATATYPE

Constructor Summary

UserAggregate(Database db, int id, java.lang.String name, java.lang.String className, boolean force)

Method Summary

void	checkRename() Check if this object can be renamed.
java.lang.String	getCreateSQL() Build a SQL statement to re-create this object.
java.lang.String	getCreateSQLForCopy(Table table, java.lang.String quotedName) Build a SQL statement to re-create the object, or to create a copy of the object with a different name or referencing a different table
java.lang.String	getDropSQL() Build a SQL statement to drop this object.
AggregateFunction	getInstance()
java.lang.String	getJavaClassName()
int	getType() Get the object type.
void	removeChildrenAndResources(Session session) Remove all dependent objects and free all resources (files, blocks in files) of this object.

Methods inherited from class org.h2.engine.DbObjectBase

getChildren, getComment, getDatabase, getHeadPos, getId, getModificationId, getName, getSQL, initDbObjectBase, invalidate, isTemporary, rename, setComment, setModified, setObjectName, setTemporary, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAggregate

public UserAggregate(Database db,
                     int id,
                     java.lang.String name,
                     java.lang.String className,
                     boolean force)
              throws java.sql.SQLException

Throws:

java.sql.SQLException

Method Detail

getInstance

public AggregateFunction getInstance()
                              throws java.sql.SQLException

Throws:

java.sql.SQLException

getCreateSQLForCopy

public java.lang.String getCreateSQLForCopy(Table table,
                                            java.lang.String quotedName)

Description copied from class: DbObjectBase

Build a SQL statement to re-create the object, or to create a copy of the object with a different name or referencing a different table

Specified by:

getCreateSQLForCopy in interface DbObject

Specified by:

getCreateSQLForCopy in class DbObjectBase

Parameters:

table - the new table name

quotedName - the new quoted name

Returns:

the SQL statement

getDropSQL

public java.lang.String getDropSQL()

Description copied from class: DbObjectBase

Build a SQL statement to drop this object.

Specified by:

getDropSQL in interface DbObject

Specified by:

getDropSQL in class DbObjectBase

Returns:

the SQL statement

getCreateSQL

public java.lang.String getCreateSQL()

Description copied from class: DbObjectBase

Build a SQL statement to re-create this object.

Specified by:

getCreateSQL in interface DbObject

Specified by:

getCreateSQL in class DbObjectBase

Returns:

the SQL statement

getType

public int getType()

Description copied from class: DbObjectBase

Get the object type.

Specified by:

getType in interface DbObject

Specified by:

getType in class DbObjectBase

Returns:

the object type

removeChildrenAndResources

public void removeChildrenAndResources(Session session)
                                throws java.sql.SQLException

Description copied from class: DbObjectBase

Remove all dependent objects and free all resources (files, blocks in files) of this object.

Specified by:

removeChildrenAndResources in interface DbObject

Specified by:

removeChildrenAndResources in class DbObjectBase

Parameters:

session - the session

Throws:

java.sql.SQLException

checkRename

public void checkRename()
                 throws java.sql.SQLException

Description copied from class: DbObjectBase

Check if this object can be renamed. System objects may not be renamed.

Specified by:

checkRename in interface DbObject

Specified by:

checkRename in class DbObjectBase

Throws:

java.sql.SQLException - if renaming is not allowed

getJavaClassName

public java.lang.String getJavaClassName()