org.apache.derby.iapi.sql.dictionary

Class ViewDescriptor

java.lang.Object

org.apache.derby.iapi.sql.dictionary.TupleDescriptor

org.apache.derby.iapi.sql.dictionary.UniqueTupleDescriptor

org.apache.derby.iapi.sql.dictionary.ViewDescriptor

All Implemented Interfaces:

Dependable, Dependent, Provider

public final class ViewDescriptor
extends UniqueTupleDescriptor
implements Dependent, Provider

This is the implementation of ViewDescriptor. Users of View descriptors should only use the following methods:

1. getUUID
2. setUUID
3. getViewText
4. setViewName
5. getCheckOptionType
6. getCompSchemaId

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_CHECK_OPTION

Fields inherited from interface org.apache.derby.catalog.Dependable

ACTIVATION, ALIAS, COLUMNS_IN_TABLE, COLUMNS_PERMISSION, CONGLOMERATE, CONSTRAINT, DEFAULT, FILE, HEAP, INDEX, PERM, PREPARED_STATEMENT, ROLE_GRANT, ROUTINE_PERMISSION, SCHEMA, SEQUENCE, STORED_PREPARED_STATEMENT, TABLE, TABLE_PERMISSION, TRIGGER, VIEW

Constructor Summary

Constructors

Constructor and Description
ViewDescriptor(DataDictionary dataDictionary, UUID viewID, java.lang.String viewName, java.lang.String viewText, int checkOption, UUID compSchemaId) Constructor for a ViewDescriptor.

Method Summary

Modifier and Type	Method and Description
void	drop(LanguageConnectionContext lcc, SchemaDescriptor sd, TableDescriptor td) Drop this descriptor, if not already done.
int	getCheckOptionType() Gets an identifier telling what type of check option is on this view.
java.lang.String	getClassType() Get the provider's type.
UUID	getCompSchemaId() Get the compilation type schema id when this view was first bound.
DependableFinder	getDependableFinder() Get an object which can be written to disk and which, when read from disk, will find or reconstruct this in-memory Dependable.
java.lang.String	getName()
UUID	getObjectID() Get the provider's UUID
java.lang.String	getObjectName() Return the name of this Provider.
UUID	getUUID() Gets the UUID of the view.
java.lang.String	getViewText() Gets the text of the view definition.
boolean	isValid() Check that all of the dependent's dependencies are valid.
void	makeInvalid(int action, LanguageConnectionContext lcc) Mark the dependent as invalid (due to at least one of its dependencies being invalid).
void	prepareToInvalidate(Provider p, int action, LanguageConnectionContext lcc) Prepare to mark the dependent as invalid (due to at least one of its dependencies being invalid).
void	setUUID(UUID uuid) Sets the UUID of the view.
void	setViewName(java.lang.String name) Sets the name of the view.
java.lang.String	toString() Prints the contents of the ViewDescriptor

Methods inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor

getDescriptorName, getDescriptorType, isPersistent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.derby.catalog.Dependable

isPersistent

Field Detail

NO_CHECK_OPTION

public static final int NO_CHECK_OPTION

See Also:

Constant Field Values

Constructor Detail

ViewDescriptor

public ViewDescriptor(DataDictionary dataDictionary,
                      UUID viewID,
                      java.lang.String viewName,
                      java.lang.String viewText,
                      int checkOption,
                      UUID compSchemaId)

Constructor for a ViewDescriptor.

Parameters:

dataDictionary - The data dictionary that this descriptor lives in

viewID - The UUID for the view

viewName - The name of the view

viewText - The text of the query expression from the view definition.

checkOption - int check option type

compSchemaId - the schemaid to compile in

Method Detail

getUUID

public UUID getUUID()

Gets the UUID of the view.

Specified by:

getUUID in class UniqueTupleDescriptor

Returns:

The UUID of the view.

setUUID

public void setUUID(UUID uuid)

Sets the UUID of the view.

Parameters:

uuid - The UUID of the view.

getViewText

public java.lang.String getViewText()

Gets the text of the view definition.

Returns:

A String containing the text of the CREATE VIEW statement that created the view

setViewName

public void setViewName(java.lang.String name)

Sets the name of the view.

Parameters:

name - The name of the view.

getCheckOptionType

public int getCheckOptionType()

Gets an identifier telling what type of check option is on this view.

Returns:

An identifier telling what type of check option is on the view.

getCompSchemaId

public UUID getCompSchemaId()

Get the compilation type schema id when this view was first bound.

Returns:

the schema UUID

getDependableFinder

public DependableFinder getDependableFinder()

Description copied from interface: Dependable

Get an object which can be written to disk and which, when read from disk, will find or reconstruct this in-memory Dependable.

Specified by:

getDependableFinder in interface Dependable

Returns:

the stored form of this provider

See Also:

Dependable.getDependableFinder()

getObjectName

public java.lang.String getObjectName()

Return the name of this Provider. (Useful for errors.)

Specified by:

getObjectName in interface Dependable

Returns:

String The name of this provider.

getObjectID

public UUID getObjectID()

Get the provider's UUID

Specified by:

getObjectID in interface Dependable

Returns:

String The provider's UUID

getClassType

public java.lang.String getClassType()

Get the provider's type.

Specified by:

getClassType in interface Dependable

Returns:

String The provider's type.

isValid

public boolean isValid()

Check that all of the dependent's dependencies are valid.

Specified by:

isValid in interface Dependent

Returns:

true if the dependent is currently valid

prepareToInvalidate

public void prepareToInvalidate(Provider p,
                                int action,
                                LanguageConnectionContext lcc)
                         throws StandardException

Prepare to mark the dependent as invalid (due to at least one of its dependencies being invalid).

Specified by:

prepareToInvalidate in interface Dependent

Parameters:

action - The action causing the invalidation

p - the provider

lcc - The LanguageConnectionContext

Throws:

StandardException - thrown if unable to make it invalid

makeInvalid

public void makeInvalid(int action,
                        LanguageConnectionContext lcc)
                 throws StandardException

Mark the dependent as invalid (due to at least one of its dependencies being invalid).

Specified by:

makeInvalid in interface Dependent

Parameters:

action - The action causing the invalidation

lcc - The LanguageConnectionContext

Throws:

StandardException - thrown if unable to make it invalid

toString

public java.lang.String toString()

Prints the contents of the ViewDescriptor

Overrides:

toString in class java.lang.Object

Returns:

The contents as a String

drop

public void drop(LanguageConnectionContext lcc,
                 SchemaDescriptor sd,
                 TableDescriptor td)
          throws StandardException

Drop this descriptor, if not already done.

Parameters:

lcc - current language connection context

sd - schema descriptor

td - table descriptor for this view

Throws:

StandardException - standard error policy

getName

public java.lang.String getName()