Oracle Warehouse Builder Java API Reference
10g Release 1 (10.1)

B12155-01

oracle.owb.deploy
Class DeployServiceManager

java.lang.Object
  |
  +--oracle.owb.deploy.DeployServiceManager

public class DeployServiceManager
extends java.lang.Object

DeployServiceManager contains operations (e.g. export) to handle deploying data and metadata.

Since:
Calais
Version:
Calais
Author:
Gary Hostetler (gary.hostetler@oracle.com)

Field Summary
protected static DeployServiceManager s_instance
          Instance for DeployServiceManager singleton.

 

Constructor Summary
protected DeployServiceManager()
           

 

Method Summary
 int exportMetaDataToFile(java.lang.String exportFileName, java.lang.String logFileName, java.lang.String fieldSeparator, OWBNamedObject[] exportComponents)
          Export metadata to a file for selected components.
 int exportMetaDataToFile(java.lang.String exportFileName, java.lang.String logFileName, java.lang.String fieldSeparator, OWBNamedObject[] exportComponents, java.lang.String definitionFileName)
          Export metadata to a file for selected components and metameta definitions.
 int exportMetaDataToFile(java.lang.String exportFileName, java.lang.String logFileName, java.lang.String fieldSeparator, java.lang.String projectName)
          Export metadata to a file for an entire project.
 int exportMetaDataToFile(java.lang.String exportFileName, java.lang.String logFileName, java.lang.String fieldSeparator, java.lang.String projectName, java.lang.String definitionFileName)
          Export metadata to a file for an entire project and metameta definitions.
 int exportSnapshotsToFile(java.lang.String exportFileName, java.lang.String logFileName, java.lang.String fieldSeparator, java.lang.String[] snapshotNames)
          Export metadata to a file for snapshot(s).
 int exportSnapshotsToFile(java.lang.String exportFileName, java.lang.String logFileName, java.lang.String fieldSeparator, java.lang.String[] snapshotNames, java.lang.String definitionFileName)
          Export metadata to a file for for snapshot(s).
protected  java.lang.String getControlFileName()
          Get the optional control file name to be used by MDL.
static DeployServiceManager getInstance()
          Returns the instance value for DeployServiceManager.
 void setControlFileName(java.lang.String controlFile)
          Set the optional control file name to be used by MDL.

 

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

 

Field Detail

s_instance

protected static DeployServiceManager s_instance
Instance for DeployServiceManager singleton.
Constructor Detail

DeployServiceManager

protected DeployServiceManager()
Method Detail

getInstance

public static DeployServiceManager getInstance()
Returns the instance value for DeployServiceManager.
Returns:
a DeployServiceManager object representing the instance value

setControlFileName

public void setControlFileName(java.lang.String controlFile)
Set the optional control file name to be used by MDL.
Parameters:
controlFile - Control file name to be used by MDL.
See Also:
getControlFileName()

getControlFileName

protected java.lang.String getControlFileName()
Get the optional control file name to be used by MDL.
Returns:
Control file name to be used by MDL.
See Also:
setControlFileName(java.lang.String)

exportMetaDataToFile

public int exportMetaDataToFile(java.lang.String exportFileName,
                                java.lang.String logFileName,
                                java.lang.String fieldSeparator,
                                java.lang.String projectName)
                         throws OWBException
Export metadata to a file for an entire project.
Parameters:
exportFileName - Name of MDL export data file.
logFileName - Name of MDL export log file.
fieldSeparator - Value to be used as field separator in MDL data file. Use null to have default used.
projectName - Name of project to be exported.
Returns:
A numeric indicator of whether export was successful (0=success, 1=error, 2=warning).
Throws:
OWBException - if any error occurs.

exportMetaDataToFile

public int exportMetaDataToFile(java.lang.String exportFileName,
                                java.lang.String logFileName,
                                java.lang.String fieldSeparator,
                                java.lang.String projectName,
                                java.lang.String definitionFileName)
                         throws OWBException
Export metadata to a file for an entire project and metameta definitions.
Parameters:
exportFileName - Name of MDL export data file.
logFileName - Name of MDL export log file.
fieldSeparator - Value to be used as field separator in MDL data file. Use null to have default used.
projectName - Name of project to be exported.
definitionFileName - Name of MDL Metameta definition data file.
Returns:
A numeric indicator of whether export was successful (0=success, 1=error, 2=warning).
Throws:
OWBException - if any error occurs.

exportMetaDataToFile

public int exportMetaDataToFile(java.lang.String exportFileName,
                                java.lang.String logFileName,
                                java.lang.String fieldSeparator,
OWBNamedObject[] exportComponents)
                         throws OWBException
Export metadata to a file for selected components.
Parameters:
exportFileName - Name of MDL export data file.
logFileName - Name of MDL export log file.
fieldSeparator - Value to be used as field separator in MDL data file. Use null to have default used.
exportComponents - Array of components to be exported.
Returns:
A numeric indicator of whether export was successful (0=success, 1=error, 2=warning).
Throws:
OWBException - if any error occurs.

exportMetaDataToFile

public int exportMetaDataToFile(java.lang.String exportFileName,
                                java.lang.String logFileName,
                                java.lang.String fieldSeparator,
OWBNamedObject[] exportComponents,
                                java.lang.String definitionFileName)
                         throws OWBException
Export metadata to a file for selected components and metameta definitions.
Parameters:
exportFileName - Name of MDL export data file.
logFileName - Name of MDL export log file.
fieldSeparator - Value to be used as field separator in MDL data file. Use null to have default used.
exportComponents - Array of components to be exported.
definitionFileName - Name of MDL Metameta definition data file.
Returns:
A numeric indicator of whether export was successful (0=success, 1=error, 2=warning).
Throws:
OWBException - if any error occurs.

exportSnapshotsToFile

public int exportSnapshotsToFile(java.lang.String exportFileName,
                                 java.lang.String logFileName,
                                 java.lang.String fieldSeparator,
                                 java.lang.String[] snapshotNames)
                          throws OWBException
Export metadata to a file for snapshot(s).
Parameters:
exportFileName - Name of MDL export data file.
logFileName - Name of MDL export log file.
fieldSeparator - Value to be used as field separator in MDL data file. Use null to have default used.
snapshotNames - An array of names of snapshots to be exported.
Returns:
A numeric indicator of whether export was successful (0=success, 1=error, 2=warning).
Throws:
OWBException - if any error occurs.

exportSnapshotsToFile

public int exportSnapshotsToFile(java.lang.String exportFileName,
                                 java.lang.String logFileName,
                                 java.lang.String fieldSeparator,
                                 java.lang.String[] snapshotNames,
                                 java.lang.String definitionFileName)
                          throws OWBException
Export metadata to a file for for snapshot(s).
Parameters:
exportFileName - Name of MDL export data file.
logFileName - Name of MDL export log file.
fieldSeparator - Value to be used as field separator in MDL data file. Use null to have default used.
snapshotNames - An array of names of snapshots to be exported.
definitionFileName - Name of MDL Metameta definition data file.
Returns:
A numeric indicator of whether export was successful (0=success, 1=error, 2=warning).
Throws:
OWBException - if any error occurs.

Oracle Warehouse Builder Java API Reference
10g Release 1 (10.1)

B12155-01

Copyright © 2003, Oracle. All Rights Reserved.