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

B12155-01

oracle.owb.Import
Class ImportServiceManager

java.lang.Object
  |
  +--oracle.owb.Import.ImportServiceManager

public class ImportServiceManager
extends java.lang.Object

ImportServiceManager contains operations to handle importing metadata.

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

Field Summary
static java.lang.String CREATEMODE
          MDL import mode for creating new objects only.
static java.lang.String MERGEMODE
          MDL import mode for incrementally updating (merging) objects that already exist and creating new objects that do not exist.
static java.lang.String REPLACEMODE
          MDL import mode for replacing objects that already exist only.
protected static ImportServiceManager s_instance
          Instance for ImportServiceManager singleton.
static java.lang.String UPDATEMODE
          MDL import mode for replacing objects that already exist and creating new objects that do not exist.

 

Constructor Summary
protected ImportServiceManager()
           

 

Method Summary
protected  java.lang.String getAutoUpgrade()
          Get the flag that indicates whether or not to automatically upgrade MDL data files from previous releases.
protected  java.lang.String getControlFileName()
          Get the optional control file name to be used by MDL.
protected  java.lang.String getImportAsSnapshot()
          Get the name of a new snapshot that MDL data files should be imported into. releases.
static ImportServiceManager getInstance()
          Returns the instance value for ImportServiceManager.
 int importMetaDataFromFile(java.lang.String importFileName, java.lang.String logFileName, java.lang.String importMode)
          Import metadata from a file.
 int importMetaDataFromFile(java.lang.String importFileName, java.lang.String logFileName, java.lang.String importMode, java.lang.String definitionFileName)
          Import metadata from a file and a metameta definition file.
 void setAutoUpgrade(boolean autoUpgrade)
          Set the flag that indicates whether or not to automatically upgrade MDL data files from previous releases.
 void setControlFileName(java.lang.String controlFile)
          Set the optional control file name to be used by MDL.
 void setImportAsSnapshot(java.lang.String snapshotName)
          Set the name of a new snapshot that MDL data files should be imported into.

 

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

 

Field Detail

CREATEMODE

public static final java.lang.String CREATEMODE
MDL import mode for creating new objects only.
See Also:
Constant Field Values

UPDATEMODE

public static final java.lang.String UPDATEMODE
MDL import mode for replacing objects that already exist and creating new objects that do not exist.
See Also:
Constant Field Values

REPLACEMODE

public static final java.lang.String REPLACEMODE
MDL import mode for replacing objects that already exist only.
See Also:
Constant Field Values

MERGEMODE

public static final java.lang.String MERGEMODE
MDL import mode for incrementally updating (merging) objects that already exist and creating new objects that do not exist.
See Also:
Constant Field Values

s_instance

protected static ImportServiceManager s_instance
Instance for ImportServiceManager singleton.
Constructor Detail

ImportServiceManager

protected ImportServiceManager()
Method Detail

getInstance

public static ImportServiceManager getInstance()
Returns the instance value for ImportServiceManager.
Returns:
an ImportServiceManager 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)

setAutoUpgrade

public void setAutoUpgrade(boolean autoUpgrade)
Set the flag that indicates whether or not to automatically upgrade MDL data files from previous releases.
Parameters:
autoUpgrade - Boolean value that indicates whether or not to automatically upgrade MDL data files from previous releases (default is true).
See Also:
getAutoUpgrade()

getAutoUpgrade

protected java.lang.String getAutoUpgrade()
Get the flag that indicates whether or not to automatically upgrade MDL data files from previous releases.
Returns:
Boolean value that indicates whether or not to automatically upgrade MDL data files from previous releases (default is true).
See Also:
setAutoUpgrade(boolean)

setImportAsSnapshot

public void setImportAsSnapshot(java.lang.String snapshotName)
Set the name of a new snapshot that MDL data files should be imported into.
Parameters:
snapshotName - Name of the snapshot that should be created and the MDL file imported into.
See Also:
getImportAsSnapshot()

getImportAsSnapshot

protected java.lang.String getImportAsSnapshot()
Get the name of a new snapshot that MDL data files should be imported into. releases.
Returns:
Name of the snapshot that should be created and the MDL file imported into.
See Also:
setImportAsSnapshot(java.lang.String)

importMetaDataFromFile

public int importMetaDataFromFile(java.lang.String importFileName,
                                  java.lang.String logFileName,
                                  java.lang.String importMode)
                           throws OWBException
Import metadata from a file.
Parameters:
importFileName - Name of MDL import data file.
logFileName - Name of MDL import log file.
importMode - Import mode (CREATE, REPLACE, UPDATE, or MERGE)
Returns:
A numeric indicator of whether export was successful (0=success, 1=error, 2=warning).
Throws:
OWBException - if any error occurs.

importMetaDataFromFile

public int importMetaDataFromFile(java.lang.String importFileName,
                                  java.lang.String logFileName,
                                  java.lang.String importMode,
                                  java.lang.String definitionFileName)
                           throws OWBException
Import metadata from a file and a metameta definition file.
Parameters:
importFileName - Name of MDL import data file.
logFileName - Name of MDL import log file.
importMode - Import mode (CREATE, REPLACE, UPDATE, or MERGE)
definitionFileName - Name of MDL metameta definition 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.