public final class TransferDescriptor extends HashStructureAdapter implements PropertyStorage
TransferState
accessible using getTransferState()
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
KEY |
_hash
DATA_KEY
Constructor and Description |
---|
TransferDescriptor()
Construct a new
TransferDescriptor with default
option values. |
TransferDescriptor(HashStructure hash) |
Modifier and Type | Method and Description |
---|---|
void |
clearTransferState()
Clears the state of this transfer descriptor.
|
java.lang.Object |
copyTo(java.lang.Object target)
Copy support.
|
PropertyAction.Type |
getCreateReplaceAlter() |
int |
getDependencyDepth() |
java.lang.String |
getImportGenerateConn()
Deprecated.
no longer used.
|
java.lang.String |
getImportGenerateKey()
Deprecated.
no longer used.
|
boolean |
getIncludeAllDependencies() |
boolean |
getIncludeDependencies() |
java.lang.String |
getName() |
DBObjectID[] |
getObjectIDs()
Deprecated.
|
DBObjectID[] |
getObjectIDs(boolean ignoreErrors)
Gets the DBObjectIDs for the objects chosen for transfer from the source
provider.
|
<T extends TransferTarget> |
getOrCreateTransferTarget(java.lang.Class<T> targetClass) |
java.lang.Class |
getPolicy() |
HashStructure |
getProperties() |
Step[] |
getReconcilePanels()
Deprecated.
- this is the compare-step of the transfer-policy
of the transfer-hook in the module extension.
|
SchemaObjectDescriptor[] |
getSchemaObjectDescriptors() |
SchemaObject[] |
getSchemaObjects()
Deprecated.
This method does not let you know that the database connection
has been lost.
If the caller does not care, use getSchemaObjects( true )
and ignore the exception instead.
Otherwise, use getSchemaObjects( false ) and handle the exception
|
SchemaObject[] |
getSchemaObjects(boolean ignoreErrors)
Deprecated.
|
SchemaObject[] |
getSchemaObjectsAndDependencies()
Deprecated.
use getSchemaObjectsAndDependencies( boolean ignoreErrors )
instead.
|
SchemaObject[] |
getSchemaObjectsAndDependencies(boolean ignoreErrors)
Deprecated.
use
getSystemObjectsAndDependencies( validTypes, boolean) |
Step[] |
getScriptPanels()
Deprecated.
- SQL script generation is no longer
an optional part of generating a database
|
java.lang.Object |
getSource()
Get the source of the objects to transfer.
|
java.lang.String |
getSourceApplicationName()
Deprecated.
- the app/proj are not needed to perform the transfer, just
the offlinedb url.
|
java.lang.String |
getSourceConnectionStore()
Deprecated.
- the store should be encoded into the identifier
|
java.lang.String |
getSourceProjectName()
Deprecated.
- the app/proj are not needed to perform the transfer, just
the offlinedb url.
|
DBObjectProvider |
getSourceProvider() |
java.lang.String |
getSourceProviderType() |
SystemObject[] |
getSystemObjects()
Deprecated.
this method does not let the caller know
if the database connection is lost.
|
SystemObject[] |
getSystemObjects(boolean ignoreErrors)
convenience method to return the source objects.
|
SystemObject[] |
getSystemObjectsAndDependencies()
Deprecated.
Use getSystemObjectsAndDependencies( validTypes, true ) if
you dont want to get a DBException.
Or better, getSystemObjectsAndDependencies( validTypes, false ) if the caller
will handle the exception. A DBException will be throw if the
database connection is lost.
|
SystemObject[] |
getSystemObjectsAndDependencies(boolean ignoreErrors)
Deprecated.
Use
getSystemObjectsAndDependencies( validTypes, ignoreErrors ) |
SystemObject[] |
getSystemObjectsAndDependencies(java.util.Collection<java.lang.String> validTypes,
boolean ignoreErrors)
Convenience method to return the source objects and dependencies.
|
java.lang.Object |
getTarget() |
java.lang.String |
getTargetConnectionStore()
Deprecated.
- the store should be encoded into the identifier
|
java.lang.String |
getTargetID() |
DBObjectProvider |
getTargetProvider() |
java.lang.String |
getTargetProviderType() |
java.lang.String |
getTargetSchemaName()
If the returned String has length, use it to override the target schema name with this name.
|
java.lang.String |
getTargetTableSpace() |
TransferManager |
getTransferManager()
Deprecated.
the TransferManager is a singleton - use
TransferManager.getInstance() |
TransferState |
getTransferState()
Gets the current state of the transfer for this descriptor if a transfer
is in process, or null if this descriptor has not started to be
transferred yet.
|
<T extends TransferTarget> |
getTransferTarget(java.lang.Class<T> targetClass) |
TransferTarget[] |
getTransferTargets() |
TransferState |
initialiseTransferState()
This (re)initializes the TransferState object for this descriptor.
|
boolean |
isAlterWithReplace() |
boolean |
isCascadeDelete() |
boolean |
isCompare()
Is the Compare check box checked?
|
boolean |
isCompareMandatory()
Is this a Compare operation? That is doing a compare is mandatory
|
boolean |
isDowngradeOK()
Has the user accepted that this tranfer is a downgrade.
|
boolean |
isDowngradeSet()
return true if the user's downgrade intention been recorded?
|
boolean |
isIncludeStorageOptions()
The default is to include storage options
|
boolean |
isManualReconcile()
Deprecated.
- use
isCompare() |
boolean |
isPlusSqlScript() |
boolean |
isReconcile()
Deprecated.
- use
isCompare() |
boolean |
isReplace()
Deprecated.
- use getCreateReplaceAlter()
|
<T extends TransferTarget> |
removeTransferTarget(java.lang.Class<T> targetClass) |
void |
setAlterWithReplace(boolean value) |
void |
setCascadeDelete(boolean cascadeDelete) |
void |
setCompare(boolean compare)
Set compare - the state of the Compare check box
|
void |
setCompareMandatory(boolean compareMandatory)
Set compare mandatory.
|
void |
setCreateReplaceAlter(PropertyAction.Type val) |
void |
setDependencyDepth(int dependencyDepth) |
void |
setDowngradeOK(boolean downgradeOK)
Note that the user has accepted the the transfer is a downgrade.
|
void |
setImportGenerateConn(java.lang.String importGenerateConn)
Deprecated.
no longer used.
|
void |
setImportGenerateKey(java.lang.String importGenerateKey)
Deprecated.
no longer used.
|
void |
setIncludeAllDependencies(boolean includeAllDependencies) |
void |
setIncludeDependencies(boolean includeDependencies) |
void |
setIncludeStorageOptions(boolean value) |
void |
setManualReconcile(boolean manualReconcile)
Deprecated.
- use
setCompare(boolean) |
void |
setObjectIDs(DBObjectID[] ids)
Sets the objects chosen for transfer from the source provider using
their DBObejctIDs.
|
void |
setPlusSqlScrip(boolean plusSqlScrip) |
void |
setPolicy(java.lang.Class<? extends TransferPolicy> policy) |
void |
setReconcile(boolean reconcile)
Deprecated.
- use
setCompare(boolean) |
void |
setReconcilePanels(Step[] reconcilePanels)
Deprecated.
- define using the compare-step of the transfer-policy
of the transfer-hook in the module extension.
|
void |
setReplace(boolean replace)
Deprecated.
- use setCreateReplaceAlter( PropertyAction.Type.REPLACE )
if replace is true,
else setCreateReplaceAlter( PropertyAction.Type.CREATE ).
|
void |
setSchemaObjectDescriptors(SchemaObjectDescriptor[] sos) |
void |
setScriptPanels(Step[] scriptPanels)
Deprecated.
- SQL script generation is no longer
an optional part of generating a database
|
void |
setSource(java.lang.Object source)
Set the source of the objects to transfer.
|
void |
setSourceApplicationName(java.lang.String source)
Deprecated.
- the app/proj are not needed to perform the transfer, just
the offlinedb url.
|
void |
setSourceConnectionStore(java.lang.String source)
Deprecated.
the store should be encoded into the identifier
|
void |
setSourceProjectName(java.lang.String source)
Deprecated.
- the app/proj are not needed to perform the transfer, just
the offlinedb url.
|
void |
setSourceProvider(DBObjectProvider pro) |
void |
setSourceProviderType(java.lang.String providerType) |
void |
setTarget(java.lang.Object obj) |
void |
setTargetConnectionStore(java.lang.String target)
Deprecated.
the conn store is encoded into the provider id
|
void |
setTargetID(java.lang.String targetID)
Save the targetID from the hook for this transfer
|
void |
setTargetProvider(DBObjectProvider pro) |
void |
setTargetProviderType(java.lang.String providerType) |
void |
setTargetSchemaName(java.lang.String schemaName)
Set the target schem name to be used
|
void |
setTargetTableSpace(java.lang.String schemaName) |
addStructureChangeListener, containsKey, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals
public static final java.lang.String KEY
public TransferDescriptor()
TransferDescriptor
with default
option values.public TransferDescriptor(HashStructure hash)
public java.lang.Object copyTo(java.lang.Object target)
HashStructureAdapter
copyTo
in class HashStructureAdapter
public java.lang.String getName()
public TransferState initialiseTransferState()
public TransferState getTransferState()
public void clearTransferState()
public DBObjectID[] getObjectIDs(boolean ignoreErrors) throws TransferFailedException
ignoreErrors
- whether to ignore errors in retrieving the ids.DBException
- if the source provider, or the objects to transfer,
cannot be retrieved.TransferFailedException
public void setObjectIDs(DBObjectID[] ids)
public PropertyAction.Type getCreateReplaceAlter()
public void setCreateReplaceAlter(PropertyAction.Type val)
@Deprecated public boolean isReplace()
@Deprecated public void setReplace(boolean replace)
public boolean isAlterWithReplace()
public void setAlterWithReplace(boolean value)
public boolean isCascadeDelete()
public void setCascadeDelete(boolean cascadeDelete)
public boolean isIncludeStorageOptions()
public void setIncludeStorageOptions(boolean value)
public java.lang.String getTargetSchemaName()
public void setTargetSchemaName(java.lang.String schemaName)
public java.lang.String getTargetTableSpace()
public void setTargetTableSpace(java.lang.String schemaName)
public void setTarget(java.lang.Object obj)
public java.lang.Object getTarget()
public void setTargetProviderType(java.lang.String providerType)
public java.lang.String getTargetProviderType()
public DBObjectProvider getTargetProvider() throws TransferFailedException
TransferFailedException
public void setTargetProvider(DBObjectProvider pro)
public void setSchemaObjectDescriptors(SchemaObjectDescriptor[] sos)
public SchemaObjectDescriptor[] getSchemaObjectDescriptors()
public boolean getIncludeDependencies()
public void setIncludeDependencies(boolean includeDependencies)
public boolean getIncludeAllDependencies()
public void setIncludeAllDependencies(boolean includeAllDependencies)
public int getDependencyDepth()
public void setDependencyDepth(int dependencyDepth)
public boolean isPlusSqlScript()
public void setPlusSqlScrip(boolean plusSqlScrip)
public boolean isDowngradeOK()
public boolean isDowngradeSet()
public void setDowngradeOK(boolean downgradeOK)
public void setSource(java.lang.Object source)
public java.lang.Object getSource()
DBObjectProvider.getProviderIdentifier()
public void setSourceProviderType(java.lang.String providerType)
public java.lang.String getSourceProviderType()
public void setSourceProvider(DBObjectProvider pro)
public DBObjectProvider getSourceProvider() throws TransferFailedException
TransferFailedException
public void setPolicy(java.lang.Class<? extends TransferPolicy> policy)
public java.lang.Class getPolicy()
public TransferTarget[] getTransferTargets()
public <T extends TransferTarget> T getTransferTarget(java.lang.Class<T> targetClass)
public <T extends TransferTarget> T getOrCreateTransferTarget(java.lang.Class<T> targetClass)
public <T extends TransferTarget> T removeTransferTarget(java.lang.Class<T> targetClass)
public SystemObject[] getSystemObjects(boolean ignoreErrors) throws TransferFailedException
ignoreErrors
- If true, DBExceptions are ignored.TransferFailedException
@Deprecated public SystemObject[] getSystemObjectsAndDependencies(boolean ignoreErrors) throws TransferFailedException
getSystemObjectsAndDependencies( validTypes, ignoreErrors )
TransferFailedException
public SystemObject[] getSystemObjectsAndDependencies(java.util.Collection<java.lang.String> validTypes, boolean ignoreErrors) throws TransferFailedException
validTypes
- - if not null, only look for the dependecies of valid typesignoreErrors
- - if true, this method will swallow DBExceptionsTransferFailedException
public HashStructure getProperties()
getProperties
in interface PropertyStorage
HashStructure
wrapped by this PropertyStorage.public boolean isCompare()
public void setCompare(boolean compare)
public boolean isCompareMandatory()
public void setCompareMandatory(boolean compareMandatory)
public void setTargetID(java.lang.String targetID)
public java.lang.String getTargetID()
@Deprecated public boolean isReconcile()
isCompare()
@Deprecated public void setReconcile(boolean reconcile)
setCompare(boolean)
@Deprecated public boolean isManualReconcile()
isCompare()
@Deprecated public void setManualReconcile(boolean manualReconcile)
setCompare(boolean)
@Deprecated public void setReconcilePanels(Step[] reconcilePanels)
@Deprecated public Step[] getReconcilePanels()
@Deprecated public void setScriptPanels(Step[] scriptPanels)
@Deprecated public Step[] getScriptPanels()
@Deprecated public TransferManager getTransferManager()
TransferManager.getInstance()
@Deprecated public SchemaObject[] getSchemaObjectsAndDependencies()
@Deprecated public DBObjectID[] getObjectIDs()
@Deprecated public SchemaObject[] getSchemaObjects()
@Deprecated public SystemObject[] getSystemObjects()
@Deprecated public SystemObject[] getSystemObjectsAndDependencies()
@Deprecated public SchemaObject[] getSchemaObjects(boolean ignoreErrors) throws TransferFailedException
getSystemObjects(boolean)
TransferFailedException
@Deprecated public SchemaObject[] getSchemaObjectsAndDependencies(boolean ignoreErrors) throws TransferFailedException
getSystemObjectsAndDependencies( validTypes, boolean)
TransferFailedException
@Deprecated public void setImportGenerateKey(java.lang.String importGenerateKey)
@Deprecated public java.lang.String getImportGenerateKey()
@Deprecated public void setImportGenerateConn(java.lang.String importGenerateConn)
@Deprecated public java.lang.String getImportGenerateConn()
@Deprecated public void setTargetConnectionStore(java.lang.String target)
@Deprecated public java.lang.String getTargetConnectionStore()
@Deprecated public void setSourceApplicationName(java.lang.String source)
@Deprecated public java.lang.String getSourceApplicationName()
@Deprecated public void setSourceProjectName(java.lang.String source)
@Deprecated public java.lang.String getSourceProjectName()
@Deprecated public void setSourceConnectionStore(java.lang.String source)
@Deprecated public java.lang.String getSourceConnectionStore()