Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.9.0)

E52944-01


oracle.jdeveloper.offlinedb.model
Class GenerateDescriptor

java.lang.Object
  extended by oracle.jdeveloper.offlinedb.model.GenerateDescriptor

All Implemented Interfaces:
Copyable, DynamicPropertySet

public class GenerateDescriptor
extends java.lang.Object
implements DynamicPropertySet, Copyable

Bean to encapsulte generation options to be used as the model for a deployment descriptor.


Field Summary
static java.lang.String KEY
           

 

Constructor Summary
GenerateDescriptor()
           

 

Method Summary
 java.lang.Object copyTo(java.lang.Object target)
          Copies the internal state of this object to the specified copy.
protected  void copyToImpl(GenerateDescriptor target)
           
 boolean equals(java.lang.Object obj)
           
protected  boolean equalsImpl(GenerateDescriptor other)
           
 java.lang.String getConnectionName()
           
 DBObjectID[] getObjectIDs()
           
 java.util.Map getProperties()
          Retrieves a map holding the property-value pairs.
 java.lang.Object getProperty(java.lang.String key)
          Retrieves the value associated with a property.
 java.lang.Object getProperty(java.lang.String key, java.lang.Object defaultValue)
          Retrieves the value associated with a property.
 java.lang.String getSchemaName()
           
 java.net.URL getSQLFileURL()
           
 boolean isCascadeDelete()
           
 boolean isGeneratePrompts()
           
 boolean isGenerateSchemaNames()
           
 boolean isGenerateScripts()
           
 boolean isGenerateSpoolCommands()
           
 boolean isGenerateToDatabase()
           
 boolean isManualReconcile()
           
 boolean isReconcile()
           
 boolean isReplace()
           
 void setCascadeDelete(boolean cascadeDelete)
           
 void setConnectionName(java.lang.String connName)
           
 void setGeneratePrompts(boolean prompts)
           
 void setGenerateSchemaNames(boolean schemaName)
           
 void setGenerateScripts(boolean scripts)
           
 void setGenerateSpoolCommands(boolean spool)
           
 void setGenerateToDatabase(boolean db)
           
 void setManualReconcile(boolean manualReconcile)
           
 void setObjectIDs(DBObjectID[] ids)
           
 void setProperties(java.util.Map properties)
          Sets the map holding the property-value pairs.
 void setProperty(java.lang.String key, java.lang.Object value)
          Sets the value for a property.
 void setReconcile(boolean reconcile)
           
 void setReplace(boolean replace)
           
 void setSchemaName(java.lang.String schemaName)
           
 void setSQLFileURL(java.net.URL url)
           

 

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

KEY

public static final java.lang.String KEY
See Also:
Constant Field Values

Constructor Detail

GenerateDescriptor

public GenerateDescriptor()

Method Detail

getObjectIDs

public DBObjectID[] getObjectIDs()

setObjectIDs

public void setObjectIDs(DBObjectID[] ids)

isReplace

public boolean isReplace()

setReplace

public void setReplace(boolean replace)

isCascadeDelete

public boolean isCascadeDelete()

setCascadeDelete

public void setCascadeDelete(boolean cascadeDelete)

isReconcile

public boolean isReconcile()

setReconcile

public void setReconcile(boolean reconcile)

isManualReconcile

public boolean isManualReconcile()

setManualReconcile

public void setManualReconcile(boolean manualReconcile)

isGenerateScripts

public boolean isGenerateScripts()

setGenerateScripts

public void setGenerateScripts(boolean scripts)

isGenerateToDatabase

public boolean isGenerateToDatabase()

setGenerateToDatabase

public void setGenerateToDatabase(boolean db)

getConnectionName

public java.lang.String getConnectionName()

setConnectionName

public void setConnectionName(java.lang.String connName)

getSchemaName

public java.lang.String getSchemaName()

setSchemaName

public void setSchemaName(java.lang.String schemaName)

getSQLFileURL

public java.net.URL getSQLFileURL()

setSQLFileURL

public void setSQLFileURL(java.net.URL url)

isGeneratePrompts

public boolean isGeneratePrompts()

setGeneratePrompts

public void setGeneratePrompts(boolean prompts)

isGenerateSpoolCommands

public boolean isGenerateSpoolCommands()

setGenerateSpoolCommands

public void setGenerateSpoolCommands(boolean spool)

isGenerateSchemaNames

public boolean isGenerateSchemaNames()

setGenerateSchemaNames

public void setGenerateSchemaNames(boolean schemaName)

getProperties

public java.util.Map getProperties()
Description copied from interface: DynamicPropertySet
Retrieves a map holding the property-value pairs.
Specified by:
getProperties in interface DynamicPropertySet

getProperty

public java.lang.Object getProperty(java.lang.String key)
Description copied from interface: DynamicPropertySet
Retrieves the value associated with a property.
Specified by:
getProperty in interface DynamicPropertySet
Parameters:
key - the property key for which a value is desired. exists.
Returns:
the value of the requested property, or a null value if the property does not exist or is not set.

getProperty

public java.lang.Object getProperty(java.lang.String key,
                                    java.lang.Object defaultValue)
Description copied from interface: DynamicPropertySet
Retrieves the value associated with a property. If no value exists for the requested property, the specified default value is returned.
Specified by:
getProperty in interface DynamicPropertySet
Parameters:
key - the property key for which a value is desired.
defaultValue - the value to return if no value currently exists.
Returns:
the value of the requested property, or the default value if the property does not exist.

setProperties

public void setProperties(java.util.Map properties)
Description copied from interface: DynamicPropertySet
Sets the map holding the property-value pairs.
Specified by:
setProperties in interface DynamicPropertySet

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)
Description copied from interface: DynamicPropertySet
Sets the value for a property. Setting a value to null removes that property.
Specified by:
setProperty in interface DynamicPropertySet
Parameters:
key - the property key to set
value - the value to set

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
Parameters:
target - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.
Returns:
The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

copyToImpl

protected void copyToImpl(GenerateDescriptor target)

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

equalsImpl

protected boolean equalsImpl(GenerateDescriptor other)

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.9.0)

E52944-01


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