Extension SDK

oracle.jdeveloper.cm.ds.db
Class Synonym

java.lang.Object
  extended byoracle.jdeveloper.cm.ds.db.DBObject
      extended byoracle.jdeveloper.cm.ds.db.SchemaObject
          extended byoracle.jdeveloper.cm.ds.db.Synonym
All Implemented Interfaces:
Copyable

public class Synonym
extends SchemaObject

Model of a database synonym.


Field Summary
 
Fields inherited from class oracle.jdeveloper.cm.ds.db.DBObject
ANONYMOUS_BLOCK, COLUMN, CONSTRAINT, FUNCTION, INDEX, PACKAGE_BODY, PACKAGE_SPEC, PROCEDURE, SEQUENCE, SYNONYM, TABLE, WORKAREA
 
Constructor Summary
Synonym()
          Constructor
Synonym(java.lang.String name)
           
 
Method Summary
 java.lang.Object copyTo(java.lang.Object target)
          Copies the internal state of this object to the specified copy.
protected  void copyToImpl(Synonym copy)
           
 boolean equals(java.lang.Object target)
           
protected  boolean equalsImpl(Synonym target)
           
 java.util.Iterator getChildren()
          If this object has subobjects (i.e.
 java.lang.String getTargetName()
          Gets the target objects name
 java.lang.String getTargetSchema()
          Gets the target objects schema
 int getTargetType()
          Gets the target objects type
 java.lang.String getType()
          Returns the type of object this is.
 void setTargetName(java.lang.String name)
          Sets the target objects name
 void setTargetSchema(java.lang.String schema)
          Sets the target objects schema
 void setTargetType(int type)
          Sets the target objects type
 
Methods inherited from class oracle.jdeveloper.cm.ds.db.SchemaObject
copyToImpl, equalsImpl, getCatalog, getSchema, setCatalog, setSchema
 
Methods inherited from class oracle.jdeveloper.cm.ds.db.DBObject
copyToImpl, equalsImpl, getName, setName, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Synonym

public Synonym()
Constructor


Synonym

public Synonym(java.lang.String name)
Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object target)
Description copied from interface: Copyable
Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:

public Object copyTo( Object target )
{
final <this_class> copy =
target != null ? (<this_class>) target : new <this_class>();
copyToImpl( copy );
return copy;
} protected final void copyToImpl( <this_class> copy ) { super.copyToImpl( copy ); // if necessary // put code here for copying the properties of <this_class> }
The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Specified by:
copyTo in interface Copyable
Specified by:
copyTo in class DBObject

copyToImpl

protected void copyToImpl(Synonym copy)

equals

public boolean equals(java.lang.Object target)
Specified by:
equals in class DBObject

equalsImpl

protected boolean equalsImpl(Synonym target)

setTargetSchema

public void setTargetSchema(java.lang.String schema)
Sets the target objects schema


getTargetSchema

public java.lang.String getTargetSchema()
Gets the target objects schema


setTargetName

public void setTargetName(java.lang.String name)
Sets the target objects name


getTargetName

public java.lang.String getTargetName()
Gets the target objects name


setTargetType

public void setTargetType(int type)
Sets the target objects type

Parameters:
type - a Type defined in DatabaseObjectType

getTargetType

public int getTargetType()
Gets the target objects type


getType

public java.lang.String getType()
Description copied from class: DBObject
Returns the type of object this is. The object type is defined as constants in DBObject

Specified by:
getType in class DBObject
See Also:
DBObject.TABLE, DBObject.WORKAREA, DBObject.COLUMN

getChildren

public java.util.Iterator getChildren()
Description copied from class: DBObject
If this object has subobjects (i.e. a table contains columns), then this will return an Iterator on that list of children, otherwise it will return null.

Specified by:
getChildren in class DBObject

Extension SDK

 

Copyright ©1997, 2003, Oracle. All rights reserved.