org.h2.engine
Class Comment

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

All Implemented Interfaces:

DbObject

public class Comment
extends DbObjectBase

Represents a database object comment.

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

Comment(Database database, int id, DbObject obj)

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.
static java.lang.String	getKey(DbObject obj) Get the comment key name for the given database object.
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.
void	setCommentText(java.lang.String comment) Set the comment text.

Methods inherited from class org.h2.engine.DbObjectBase

getChildren, getComment, getDatabase, 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

Comment

public Comment(Database database,
               int id,
               DbObject obj)

Method Detail

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)

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

checkRename

public void checkRename()

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

getKey

public static java.lang.String getKey(DbObject obj)

Get the comment key name for the given database object. This key name is used internally to associate the comment to the object.

Parameters:

obj - the object

Returns:

the key name

setCommentText

public void setCommentText(java.lang.String comment)

Set the comment text.

Parameters:

comment - the text