oracle.jdeveloper.cm.ds.db
Class AbstractDBObjectBuilder

java.lang.Object
  oracle.jdeveloper.cm.ds.db.AbstractDBObjectBuilder

All Implemented Interfaces:

DBObjectBuilder

Direct Known Subclasses:

DMDBuilder

public class AbstractDBObjectBuilder

extends java.lang.Object

implements DBObjectBuilder

Constructor Summary

protected

AbstractDBObjectBuilder(java.lang.String type)

Method Summary

SchemaObject	buildObject(DBObjectID id) Builds a new SchemaObject instance, using the specified ID.
SchemaObject	buildObject(Schema schema, java.lang.String name) Builds a new SchemaObject instance.
java.lang.String	getObjectType() Retrieves the type of object that this DBObjectBuilder instance creates.
java.lang.Long	getTimestamp(Schema schema, java.lang.String name) Retrieves the the timestamp for this object.
java.lang.String[]	listObjects(Schema schema, java.lang.String ref) Lists the names of the objects that can be provided by this builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDBObjectBuilder

protected AbstractDBObjectBuilder(java.lang.String type)

Method Detail

getObjectType

public java.lang.String getObjectType()

Description copied from interface: DBObjectBuilder

Retrieves the type of object that this DBObjectBuilder instance creates.

Specified by:

getObjectType in interface DBObjectBuilder

Returns:

a string specifying the object type supported

See Also:

DBObject.getType()

listObjects

public java.lang.String[] listObjects(Schema schema,
                                      java.lang.String ref)
                               throws DBException

Description copied from interface: DBObjectBuilder

Lists the names of the objects that can be provided by this builder.

Specified by:

listObjects in interface DBObjectBuilder

Parameters:

schema - the schema to look for objects in

ref - a string containing a pattern that can used to match names; a ref of null indicates that all objects should be returned

Returns:

an array of object names

Throws:

DBException - if an error is encountered getting the list

buildObject

public SchemaObject buildObject(Schema schema,
                                java.lang.String name)
                         throws DBException

Description copied from interface: DBObjectBuilder

Builds a new SchemaObject instance. A given DBObjectBuilder instance works with a specific type of SchemaObject; all SchemaObject instances created by a DBObjectBuilder will be of the same type.

Specified by:

buildObject in interface DBObjectBuilder

Parameters:

schema - the schema containing the object

name - a string specifying the name of the new object

Returns:

a new SchemaObject instance representing the requested object, or null if no such object can be built

Throws:

DBException - if an error is encountered creating the object

buildObject

public SchemaObject buildObject(DBObjectID id)
                         throws DBException

Description copied from interface: DBObjectBuilder

Builds a new SchemaObject instance, using the specified ID.

Specified by:

buildObject in interface DBObjectBuilder

Parameters:

id - the ID associated with the new instance

Returns:

a new SchemaObject instance representing the requested object, or null if no such object can be built

Throws:

DBException - if an error is encountered creating the object

getTimestamp

public java.lang.Long getTimestamp(Schema schema,
                                   java.lang.String name)
                            throws DBException

Description copied from interface: DBObjectBuilder

Retrieves the the timestamp for this object. The timestamp should reflect the last time the metadata for this object was modified. If the particular implementation does not support timestamps, then null should be returned.

Specified by:

getTimestamp in interface DBObjectBuilder

Parameters:

schema - The Schema containing the object

name - The name of the object

Returns:

The timestamp for the object, or null if this implementation does not support timestamps

Throws:

DBException - if an error is encountered retrieving the timestamp