Class Comment

java.lang.Object

org.h2.engine.DbObject

org.h2.engine.Comment

All Implemented Interfaces:

HasSQL

public final class Comment
extends DbObject

Represents a database object comment.

Field Summary

Fields

Modifier and Type	Field	Description
private String	commentText
private final int	objectType
private final String	quotedObjectName

Fields inherited from class DbObject

AGGREGATE, comment, COMMENT, CONSTANT, CONSTRAINT, database, DOMAIN, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, SYNONYM, TABLE_OR_VIEW, trace, TRIGGER, USER

Fields inherited from interface HasSQL

ADD_PLAN_INFORMATION, DEFAULT_SQL_FLAGS, NO_CASTS, QUOTE_ONLY_WHEN_REQUIRED, REPLACE_LOBS_FOR_TRACE, TRACE_SQL_FLAGS

Constructor Summary

Constructors

Constructor	Description
Comment(Database database, int id, DbObject obj)

Method Summary

Modifier and Type	Method	Description
void	checkRename()	Check if renaming is allowed.
String	getCreateSQL()	Construct the CREATE ...
String	getCreateSQLForCopy(Table table, 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
(package private) static String	getKey(DbObject obj)	Get the comment key name for the given database object.
int	getType()	Get the object type.
private static String	getTypeName(int type)
void	removeChildrenAndResources(SessionLocal session)	Delete all dependent children objects and resources of this object.
void	setCommentText(String comment)	Set the comment text.

Methods inherited from class DbObject

getChildren, getComment, getCreateSQLForMeta, getDatabase, getDropSQL, getId, getModificationId, getName, getSQL, getSQL, invalidate, isTemporary, isValid, rename, setComment, setModified, setObjectName, setTemporary, toString

Methods inherited from class Object

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

Methods inherited from interface HasSQL

getTraceSQL

Field Details

objectType

private final int objectType

quotedObjectName

private final String quotedObjectName

commentText

private String commentText

Constructor Details

Comment

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

Method Details

getCreateSQLForCopy

public String getCreateSQLForCopy(Table table,
 String quotedName)

Description copied from class: DbObject

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 class DbObject

Parameters:

table - the new table

quotedName - the quoted name

Returns:

the SQL statement

getTypeName

private static String getTypeName(int type)

getCreateSQL

public String getCreateSQL()

Description copied from class: DbObject

Construct the CREATE ... SQL statement for this object.

Specified by:

getCreateSQL in class DbObject

Returns:

the SQL statement

getType

public int getType()

Description copied from class: DbObject

Get the object type.

Specified by:

getType in class DbObject

Returns:

the object type

removeChildrenAndResources

public void removeChildrenAndResources(SessionLocal session)

Description copied from class: DbObject

Delete all dependent children objects and resources of this object.

Specified by:

removeChildrenAndResources in class DbObject

Parameters:

session - the session

checkRename

public void checkRename()

Description copied from class: DbObject

Check if renaming is allowed. Does nothing when allowed.

Overrides:

checkRename in class DbObject

getKey

static 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(String comment)

Set the comment text.

Parameters:

comment - the text