MdmMetadataProvider (Oracle OLAP Java API Reference)

An object that gives access to Oracle OLAP metadata objects. An application gets an MdmMetadataProvider by calling the getDefaultMetadataProvider method of the DataProvider that it is using.

Oracle OLAP metadata objects are contained by MdmSchema objects. The top-level, or root, schema is an instance of MdmRootSchema. The root schema has subschemas that are instances of MdmDatabaseSchema. Each database user has an associated MdmDatabaseSchema, which contains the metadata objects that are owned by that user.

An application creates metadata objects in the namespace of an MdmDatabaseSchema. It does so by calling methods such as the findOrCreateAW and findOrCreateStandardDimension method of the MdmDatabaseSchema.

To get Oracle OLAP metadata objects, an application first calls the getRootSchema method of the MdmMetadataProvider. The application can then get all of the metadata objects available by calling methods of the MdmRootSchema such as getDatabaseSchemas and getDimensions.

To get the metadata objects for an individual user, an application can call the getDatabaseSchema(String name) method of the MdmRootSchema. The application can then call methods of the MdmDatabaseSchema to get the objects owned by it.

When an application references metadata through an MdmMetadataProvider, Oracle OLAP retrieves information about the metadata and caches that information using the resources of the application. By calling the flushDeletedObjects method, an application can free the resources for metadata objects it has removed from an MdmSchema.

An application can also get metadata objects by importing XML definitions of those objects with the importXML methods of an MdmMetadataProvider. It can export object definitions as XML with the exportFullXML and exportIncrementalXML methods. The exportFullXML methods write the XML for all of the objects that are specified by the objects parameter or the XML for all of the objects that the application has created or modified since the Transaction specified by the sinceTxn parameter.

All objects that share an ancestor are grouped together in the XML. For any object that is not a top-level object and whose top-level container is not in the object list, the XML definition is an incremental definition to the object and a full definition below that. This supports the export of objects such as a calculated measure in a cube without having to export the whole cube.

If an MdmDatabaseSchema is in the objects list, then the export includes all objects within the database schema. If an AW is in the objects list, then the export includes all objects that belong to the AW. If an MdmRootSchema is in the list, it is ignored.

An exportIncrementalXML method records only the changes to an object. For any object, the method writes only the XML that is different than the XML for the object in the specified Transaction or in specified list of objects. The incremental XML includes the type and name of the objects in the ownership hierarchy of the changed object.

For an example of using exportFullXML and exportIncrementalXML methods, see Example 1 in Examples for MdmMetadataProvider.

With the renameMap parameter of an exportFullXML or exportIncrementalXML method, you can specify a different name for an object that you export. After committing the Transaction to save the object with the new name, you can then import the object under the new name. You then have two instances of the object under different names.

The bindVariables parameter of an exportFullXML or exportIncrementalXML method is like a SQL bind variable. With it you can specify a reference to a BaseMetadataObject object as a key and a bind variable as the value for the key. During the export of the XML, the Oracle OLAP XML generator replaces the name of the referenced object with the bind variable. The bindValues parameter of an importXML method specifies values that Oracle OLAP uses to replace bind variables when importing an XML string. For an example of exporting and importing XML using bind variables and values, see Example 2 in Examples for MdmMetadataProvider.

If an application provides a bindVariables parameter that is not null, then the XML produced by an exportFullXML or exportIncrementalXML method begins with the following declaration.

 <!DOCTYPE Metadata [
 <!ENTITY % BIND_VALUES PUBLIC "OLAP BIND VALUES" "OLAP METADATA">
 %BIND_VALUES;
 ]>

A value specified in the bindVariables map appears in the exported XML in the format "&BV;", where BV is the bind variable. The importXML methods import XML representations of objects that are owned by the an MdmDatabaseSchema and either creates new objects or modifies existing objects. If the value of the modifyIfExists parameter is true and if the imported XML contains a full definition for an object that already exists and the object definition is different from the XML, then the method merges the new or changed elements of the object definition with the existing definition of the object. If the value of modifyIfExists is false and if the XML contains a full definition for an object that already exists and the object is different from the XML, then this method throws an exception.

If an application provides a bindValues parameter that is not null, then the inXML string that it provides to an importXML method must include that !DOCTYPE Metadata declaration and the bind variables in the XML to import must be in the "&BV;" format.

With the parserCallback parameter, you can pass an implementation of the XMLParserCallback interface to an importXML method. With the XMLParserCallback, you can specify how Oracle OLAP handles an error that might occur when importing XML.

Method Summary
`java.lang.String`	`exportFullXML(java.util.List objects, java.util.Map renameMap, boolean includeOwnerString)` Exports to a `String` the full XML for all of the objects listed and possibly includes the name of the owning object.
`java.lang.String`	`exportFullXML(java.util.List objects, java.util.Map renameMap, boolean includeOwnerString, java.util.Map bindVariables)` Exports to a `String` the full XML for all of the objects listed, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the `bindVariables` parameter.
`java.lang.String`	`exportFullXML(Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString)` Exports to a `String` the full XML for all objects that have been created or modified since the specified transaction and possibly includes the name of the owning object.
`java.lang.String`	`exportFullXML(Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString, java.util.Map bindVariables)` Exports to a `String` the full XML for all objects that have been created or modified since the specified transaction, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the `bindVariables` parameter.
`void`	`exportFullXML(java.io.Writer writer, java.util.List objects, java.util.Map renameMap)` Exports to a `Writer` the full XML for all of the objects listed.
`void`	`exportFullXML(java.io.Writer writer, java.util.List objects, java.util.Map renameMap, boolean includeOwnerString)` Exports to a `Writer` the full XML for all of the objects listed and possibly includes the name of the owning object.
`void`	`exportFullXML(java.io.Writer writer, java.util.List objects, java.util.Map renameMap, boolean includeOwnerString, java.util.Map bindVariables)` Exports to a `Writer` the full XML for all of the objects listed, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the `bindVariables` parameter.
`void`	`exportFullXML(java.io.Writer writer, Transaction sinceTxn, java.util.Map renameMap)` Exports to a `Writer` the full XML for all objects that have been created or modified since the specified transaction.
`void`	`exportFullXML(java.io.Writer writer, Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString)` Exports to a `Writer` the full XML for all objects that have been created or modified since the specified transaction and possibly includes the name of the owning object.
`void`	`exportFullXML(java.io.Writer writer, Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString, java.util.Map bindVariables)` Exports to a `Writer` the full XML for all of the objects that have been created or modified since the specified transaction, possibly includes the name of the owning object and substitutes a bind variable for the objects specified by the `bindVariables` parameter.
`java.lang.String`	`exportIncrementalXML(java.util.List objects, Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString)` Exports to a `String` the XML for the attributes of the objects that have been modified since the specified `Transaction` and possibly includes the name of the owning object.
`java.lang.String`	`exportIncrementalXML(java.util.List objects, Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString, java.util.Map bindVariables)` Exports to a `String` the XML for the attributes of the objects that have been modified since the specified `Transaction`, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the `bindVariables` parameter.
`java.lang.String`	`exportIncrementalXML(Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString)` Exports to a `String` the XML for the attributes of the objects that have been modified since the specified `Transaction` and possibly includes the name of the owning object.
`java.lang.String`	`exportIncrementalXML(Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString, java.util.Map bindVariables)` Exports to a `String` the XML for the attributes of the objects that have been modified since the specified `Transaction`, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the `bindVariables` parameter.
`void`	`exportIncrementalXML(java.io.Writer writer, java.util.List objects, Transaction sinceTxn, java.util.Map renameMap)` Exports to a `Writer` the XML for the attributes of the objects that have been modified.
`void`	`exportIncrementalXML(java.io.Writer writer, java.util.List objects, Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString)` Exports to a `Writer` the XML for the attributes of the objects that have been modified and possibly includes the name of the owning object.
`void`	`exportIncrementalXML(java.io.Writer writer, java.util.List objects, Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString, java.util.Map bindVariables)` Exports to a `Writer` the XML for the attributes of the objects that have been modified, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the `bindVariables` parameter.
`void`	`exportIncrementalXML(java.io.Writer writer, Transaction sinceTxn, java.util.Map renameMap)` Exports to a `Writer` the XML for the attributes of the objects that have been modified since the specified `Transaction`.
`void`	`exportIncrementalXML(java.io.Writer writer, Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString)` Exports to a `Writer` the XML for the attributes of the objects that have been modified since the specified `Transaction` and possibly includes the name of the owning object.
`void`	`exportIncrementalXML(java.io.Writer writer, Transaction sinceTxn, java.util.Map renameMap, boolean includeOwnerString, java.util.Map bindVariables)` Exports to a `Writer` the XML for the attributes of the objects that have been modified since the specified `Transaction`, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the `bindVariables` parameter.
`MdmCustomObjectFactory`	`getMdmCustomObjectFactory()` Deprecated. As of Oracle 11g, Release 1 (11.1); replaced by methods of the owning object.
`MdmObject`	`getMetadataObject(java.lang.String id)` Gets the `MdmObject` that has the specified identifier.
`java.util.List`	`getMetadataObjects(java.lang.String[] ids)` Gets a `List` that contains the specified `MdmObject` objects.
`MtmCustomObjectFactory`	`getMtmCustomObjectFactory()` Deprecated. As of Oracle 11g, Release 1 (11.1); replaced by the methods that find or create MDM metadata objects, such as the `findOrCreateCube` method of an `MdmDatabaseSchema`.
`MtmDataTypeConverter`	`getMtmDataTypeConverter()` Deprecated. As of Oracle 11g, Release 1 (11.1); replaced by `DataType`, `SQLDataType`, and `TypedExpression`.
`MdmSchema`	`getRootSchema()` Gets the top-level `MdmSchema` in the data store to which this `MdmMetadataProvider` gives access.
`java.util.List`	`importXML(java.io.Reader in, MdmDatabaseSchema destinationSchema, boolean modifyIfExists)` Imports XML representations of objects that belong to the specified `MdmDatabaseSchema` and either creates new objects or modifies existing objects.
`java.util.List`	`importXML(java.io.Reader in, MdmDatabaseSchema destinationSchema, boolean modifyIfExists, java.util.Map<java.lang.String,java.lang.String> bindValues)` Imports XML representations of objects that belong to the specified `MdmDatabaseSchema`, creates new objects or modifies existing objects, and replaces bind variables in the XML with values.
`java.util.List`	`importXML(java.io.Reader in, MdmDatabaseSchema destinationSchema, boolean modifyIfExists, java.util.Map<java.lang.String,java.lang.String> bindValues, XMLParserCallback parserCallback)` Imports XML representations of objects that belong to the specified `MdmDatabaseSchema`, creates new objects or modifies existing objects, replaces bind variables in the XML with values, and specifies how to handle error conditions.
`java.util.List`	`importXML(java.lang.String inXML, MdmDatabaseSchema destinationSchema, boolean modifyIfExists)` Imports XML representations of objects that belong to the specified `MdmDatabaseSchema` and either creates new objects or modifies existing objects.
`java.util.List`	`importXML(java.lang.String inXML, MdmDatabaseSchema destinationSchema, boolean modifyIfExists, java.util.Map<java.lang.String,java.lang.String> bindValues)` Imports XML representations of objects that belong to the specified `MdmDatabaseSchema`, creates new objects or modifies existing objects, and replaces bind variables in the XML with values.
`java.util.List`	`importXML(java.lang.String inXML, MdmDatabaseSchema destinationSchema, boolean modifyIfExists, java.util.Map<java.lang.String,java.lang.String> bindValues, XMLParserCallback parserCallback)` Imports XML representations of objects that belong to the specified `MdmDatabaseSchema`, creates new objects or modifies existing objects, replaces bind variables in the XML with values, and specifies how to handle error conditions.
`void`	`setMdmNamingConvention(MdmNamingConvention convention)` Deprecated. As of Oracle 11g, Release 1 (11.1); no replacement.
`void`	`setMtmDataTypeConverter(MtmDataTypeConverter converter)` Deprecated. As of Oracle 11g, Release 1 (11.1); no replacement.

Methods inherited from class oracle.olapi.metadata.BaseMetadataProvider
`flushDeletedObjects, getDataProvider, getID`

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

Methods inherited from interface oracle.olapi.metadata.MetadataProvider
`getID`

Method Detail

getMetadataObject

public final MdmObject getMetadataObject(java.lang.String id)
                                  throws ObjectClosedException

Gets the MdmObject that has the specified identifier.

Parameters:: id - A String that uniquely identifies the MdmMetadataObject to be returned.
Returns:: The requested MdmObject.
Throws:: ObjectClosedException - Indicates that the requested object is not available. This can occur if the DataProvider is no longer open.

getMetadataObjects

public final java.util.List getMetadataObjects(java.lang.String[] ids)
                                        throws ObjectClosedException

Gets a List that contains the specified MdmObject objects.

Parameters:: ids - An array of String objects, each of which uniquely identifies an MdmObject.
Returns:: A List that contains an MdmObject for each of the specified identifiers.
Throws:: ObjectClosedException - Indicates that the requested object is not available. This can occur if the DataProvider is no longer open.

getRootSchema

public MdmSchema getRootSchema()

Gets the top-level MdmSchema in the data store to which this MdmMetadataProvider gives access.

Returns:: The top-level MdmSchema in the data store.

getMdmCustomObjectFactory

public final MdmCustomObjectFactory getMdmCustomObjectFactory()

Deprecated. As of Oracle 11g, Release 1 (11.1); replaced by methods of the owning object.

getMtmCustomObjectFactory

public final MtmCustomObjectFactory getMtmCustomObjectFactory()

Deprecated. As of Oracle 11g, Release 1 (11.1); replaced by the methods that find or create MDM metadata objects, such as the findOrCreateCube method of an MdmDatabaseSchema.

setMdmNamingConvention

public void setMdmNamingConvention(MdmNamingConvention convention)

Deprecated. As of Oracle 11g, Release 1 (11.1); no replacement.

getMtmDataTypeConverter

public MtmDataTypeConverter getMtmDataTypeConverter()

Deprecated. As of Oracle 11g, Release 1 (11.1); replaced by DataType, SQLDataType, and TypedExpression.

setMtmDataTypeConverter

public void setMtmDataTypeConverter(MtmDataTypeConverter converter)

Deprecated. As of Oracle 11g, Release 1 (11.1); no replacement.

exportFullXML

public final void exportFullXML(java.io.Writer writer,
                                java.util.List objects,
                                java.util.Map renameMap,
                                boolean includeOwnerString,
                                java.util.Map bindVariables)
                         throws java.io.IOException

Exports to a Writer the full XML for all of the objects listed, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the bindVariables parameter.

Parameters:: writer - A Writer that writes the XML.; objects - A List that contains BaseMetadataObject objects to export to XML.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.; bindVariables - A Map that has object references as keys and has as values String objects that contain bind variables.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportFullXML

public final void exportFullXML(java.io.Writer writer,
                                java.util.List objects,
                                java.util.Map renameMap,
                                boolean includeOwnerString)
                         throws java.io.IOException

Exports to a Writer the full XML for all of the objects listed and possibly includes the name of the owning object.

Parameters:: writer - A Writer that writes the XML.; objects - A List that contains BaseMetadataObject objects to export to XML.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportFullXML

public final void exportFullXML(java.io.Writer writer,
                                java.util.List objects,
                                java.util.Map renameMap)
                         throws java.io.IOException

Exports to a Writer the full XML for all of the objects listed.

Parameters:: writer - A Writer that writes the XML.; objects - A List that contains BaseMetadataObject objects to export to XML.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportFullXML

public final java.lang.String exportFullXML(java.util.List objects,
                                            java.util.Map renameMap,
                                            boolean includeOwnerString,
                                            java.util.Map bindVariables)
                                     throws java.io.IOException

Exports to a String the full XML for all of the objects listed, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the bindVariables parameter.

Parameters:: objects - A List that contains BaseMetadataObject objects to export to XML.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.; bindVariables - A Map that has object references as keys and has as values String objects that contain bind variables.
Returns:: A String that contains the exported XML.
Throws:: java.io.IOException - Indicates that the method cannot write the XML to a String.

exportFullXML

public final java.lang.String exportFullXML(java.util.List objects,
                                            java.util.Map renameMap,
                                            boolean includeOwnerString)
                                     throws java.io.IOException

Exports to a String the full XML for all of the objects listed and possibly includes the name of the owning object.

Parameters:: objects - A List that contains BaseMetadataObject objects to export to XML.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.
Returns:: A String that contains the exported XML.
Throws:: java.io.IOException - Indicates that the method cannot write the XML to a String.

exportFullXML

public final void exportFullXML(java.io.Writer writer,
                                Transaction sinceTxn,
                                java.util.Map renameMap,
                                boolean includeOwnerString,
                                java.util.Map bindVariables)
                         throws java.io.IOException

Exports to a Writer the full XML for all of the objects that have been created or modified since the specified transaction, possibly includes the name of the owning object and substitutes a bind variable for the objects specified by the bindVariables parameter.

Parameters:: writer - A Writer that writes the XML.; sinceTxn - The Transaction to compare to the one that contains the new or modified objects.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.; bindVariables - A Map that has object references as keys and has as values String objects that contain bind variables.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportFullXML

public final void exportFullXML(java.io.Writer writer,
                                Transaction sinceTxn,
                                java.util.Map renameMap,
                                boolean includeOwnerString)
                         throws java.io.IOException

Exports to a Writer the full XML for all objects that have been created or modified since the specified transaction and possibly includes the name of the owning object.

Parameters:: writer - A Writer that writes the XML.; sinceTxn - The Transaction to compare to the one that contains the new or modified objects.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportFullXML

public final void exportFullXML(java.io.Writer writer,
                                Transaction sinceTxn,
                                java.util.Map renameMap)
                         throws java.io.IOException

Exports to a Writer the full XML for all objects that have been created or modified since the specified transaction.

Parameters:: writer - A Writer that writes the XML.; sinceTxn - The Transaction to compare to the one that contains the new or modified objects.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportFullXML

public final java.lang.String exportFullXML(Transaction sinceTxn,
                                            java.util.Map renameMap,
                                            boolean includeOwnerString,
                                            java.util.Map bindVariables)
                                     throws java.io.IOException

Exports to a String the full XML for all objects that have been created or modified since the specified transaction, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the bindVariables parameter.

Parameters:: sinceTxn - The Transaction to compare to the one that contains the new or modified objects.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.; bindVariables - A Map that has object references as keys and has as values String objects that contain bind variables.
Returns:: A String that contains the exported XML.
Throws:: java.io.IOException - Indicates that the method cannot write the XML to a String.

exportFullXML

public final java.lang.String exportFullXML(Transaction sinceTxn,
                                            java.util.Map renameMap,
                                            boolean includeOwnerString)
                                     throws java.io.IOException

Exports to a String the full XML for all objects that have been created or modified since the specified transaction and possibly includes the name of the owning object.

Parameters:: sinceTxn - The Transaction to compare to the one that contains the new or modified objects.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.
Returns:: A String that contains the exported XML.
Throws:: java.io.IOException - Indicates that the method cannot write the XML to a String.

exportIncrementalXML

public final void exportIncrementalXML(java.io.Writer writer,
                                       java.util.List objects,
                                       Transaction sinceTxn,
                                       java.util.Map renameMap,
                                       boolean includeOwnerString,
                                       java.util.Map bindVariables)
                                throws java.io.IOException

Exports to a Writer the XML for the attributes of the objects that have been modified, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the bindVariables parameter.

Parameters:: writer - A Writer that writes the XML.; objects - A List that contains BaseMetadataObject objects to export to XML.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.; bindVariables - A Map that has object references as keys and has as values String objects that contain bind variables.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportIncrementalXML

public final void exportIncrementalXML(java.io.Writer writer,
                                       java.util.List objects,
                                       Transaction sinceTxn,
                                       java.util.Map renameMap,
                                       boolean includeOwnerString)
                                throws java.io.IOException

Exports to a Writer the XML for the attributes of the objects that have been modified and possibly includes the name of the owning object.

Parameters:: writer - A Writer that writes the XML.; objects - A List that contains BaseMetadataObject objects to export to XML.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportIncrementalXML

public final void exportIncrementalXML(java.io.Writer writer,
                                       java.util.List objects,
                                       Transaction sinceTxn,
                                       java.util.Map renameMap)
                                throws java.io.IOException

Exports to a Writer the XML for the attributes of the objects that have been modified.

Parameters:: writer - A Writer that writes the XML.; objects - A List that contains BaseMetadataObject objects to export to XML.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportIncrementalXML

public final java.lang.String exportIncrementalXML(java.util.List objects,
                                                   Transaction sinceTxn,
                                                   java.util.Map renameMap,
                                                   boolean includeOwnerString,
                                                   java.util.Map bindVariables)
                                            throws java.io.IOException

Exports to a String the XML for the attributes of the objects that have been modified since the specified Transaction, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the bindVariables parameter.

Parameters:: objects - A List that contains BaseMetadataObject objects to export to XML.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.; bindVariables - A Map that has object references as keys and has as values String objects that contain bind variables.
Returns:: A String that contains the exported XML.
Throws:: java.io.IOException - Indicates that the method cannot write the XML to a String.

exportIncrementalXML

public final java.lang.String exportIncrementalXML(java.util.List objects,
                                                   Transaction sinceTxn,
                                                   java.util.Map renameMap,
                                                   boolean includeOwnerString)
                                            throws java.io.IOException

Exports to a String the XML for the attributes of the objects that have been modified since the specified Transaction and possibly includes the name of the owning object.

Parameters:: objects - A List that contains BaseMetadataObject objects to export to XML.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.
Returns:: A String that contains the exported XML.
Throws:: java.io.IOException - Indicates that the method cannot write the XML to a String.

exportIncrementalXML

public final void exportIncrementalXML(java.io.Writer writer,
                                       Transaction sinceTxn,
                                       java.util.Map renameMap,
                                       boolean includeOwnerString,
                                       java.util.Map bindVariables)
                                throws java.io.IOException

Exports to a Writer the XML for the attributes of the objects that have been modified since the specified Transaction, possibly includes the name of the owning object, and substitutes a bind variable for the objects specified by the bindVariables parameter.

Parameters:: writer - A Writer that writes the XML.; sinceTxn - The Transaction to compare to the one that contains the new or modified objects.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.; bindVariables - A Map that has object references as keys and has as values String objects that contain bind variables.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportIncrementalXML

public final void exportIncrementalXML(java.io.Writer writer,
                                       Transaction sinceTxn,
                                       java.util.Map renameMap,
                                       boolean includeOwnerString)
                                throws java.io.IOException

Exports to a Writer the XML for the attributes of the objects that have been modified since the specified Transaction and possibly includes the name of the owning object.

Parameters:: writer - A Writer that writes the XML.; sinceTxn - The Transaction to compare to the one that contains the new or modified objects.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportIncrementalXML

public final void exportIncrementalXML(java.io.Writer writer,
                                       Transaction sinceTxn,
                                       java.util.Map renameMap)
                                throws java.io.IOException

Exports to a Writer the XML for the attributes of the objects that have been modified since the specified Transaction.

Parameters:: writer - A Writer that writes the XML.; sinceTxn - The Transaction to compare to the one that contains the new or modified objects.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.
Throws:: java.io.IOException - Indicates that the method cannot write to the specified object.

exportIncrementalXML

public final java.lang.String exportIncrementalXML(Transaction sinceTxn,
                                                   java.util.Map renameMap,
                                                   boolean includeOwnerString,
                                                   java.util.Map bindVariables)
                                            throws java.io.IOException

Parameters:: sinceTxn - The Transaction to compare to the one that contains the new or modified objects.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.; bindVariables - A Map that has object references as keys and has as values String objects that contain bind variables.
Returns:: A String that contains the exported XML.
Throws:: java.io.IOException - Indicates that the method cannot write the XML to a String.

exportIncrementalXML

public final java.lang.String exportIncrementalXML(Transaction sinceTxn,
                                                   java.util.Map renameMap,
                                                   boolean includeOwnerString)
                                            throws java.io.IOException

Exports to a String the XML for the attributes of the objects that have been modified since the specified Transaction and possibly includes the name of the owning object.

Parameters:: sinceTxn - The Transaction to compare to the one that contains the new or modified objects.; renameMap - A Map that has object references as keys and has as values String objects that contain new names for the referenced objects.; includeOwnerString - A boolean that indicates whether to include the name of the owning object in the XML.
Returns:: A String that contains the exported XML.
Throws:: java.io.IOException - Indicates that the method cannot write the XML to a String.

importXML

public final java.util.List importXML(java.io.Reader in,
                                      MdmDatabaseSchema destinationSchema,
                                      boolean modifyIfExists,
                                      java.util.Map<java.lang.String,java.lang.String> bindValues,
                                      XMLParserCallback parserCallback)
                               throws java.io.IOException,
                                      org.xml.sax.SAXException

Imports XML representations of objects that belong to the specified MdmDatabaseSchema, creates new objects or modifies existing objects, replaces bind variables in the XML with values, and specifies how to handle error conditions.

Parameters:: in - A Reader that imports the XML.; destinationSchema - The MdmDatabaseSchema to contain the new or modified objects.; modifyIfExists - A boolean that indicates whether or not modify an existing object.; bindValues - A Map that has keys that are bind variables and values that are String objects that contain the values with which to replace the bind variables.; parserCallback - An XMLParserCallback that specifies how the XML parser should handle error conditions.
Returns:: A List that contains the objects defined by the imported XML.
Throws:: java.io.IOException - Indicates that the method encountered a problem reading in the XML.; org.xml.sax.SAXException - Indicates that the method encountered a problem parsing the XML.

importXML

public final java.util.List importXML(java.io.Reader in,
                                      MdmDatabaseSchema destinationSchema,
                                      boolean modifyIfExists,
                                      java.util.Map<java.lang.String,java.lang.String> bindValues)
                               throws java.io.IOException,
                                      org.xml.sax.SAXException

Imports XML representations of objects that belong to the specified MdmDatabaseSchema, creates new objects or modifies existing objects, and replaces bind variables in the XML with values.

Parameters:: in - A Reader that imports the XML.; destinationSchema - The MdmDatabaseSchema to contain the new or modified objects.; modifyIfExists - A boolean that indicates whether or not modify an existing object.; bindValues - A Map that has keys that are bind variables and values that are String objects that contain the values with which to replace the bind variables.
Returns:: A List that contains the objects defined by the imported XML.
Throws:: java.io.IOException - Indicates that the method encountered a problem reading in the XML.; org.xml.sax.SAXException - Indicates that the method encountered a problem parsing the XML.

importXML

public final java.util.List importXML(java.io.Reader in,
                                      MdmDatabaseSchema destinationSchema,
                                      boolean modifyIfExists)
                               throws java.io.IOException,
                                      org.xml.sax.SAXException

Imports XML representations of objects that belong to the specified MdmDatabaseSchema and either creates new objects or modifies existing objects.

Parameters:: in - A Reader that imports the XML.; destinationSchema - The MdmDatabaseSchema to contain the new or modified objects.; modifyIfExists - A boolean that indicates whether to modify an existing object.
Returns:: A List that contains the objects defined by the imported XML.
Throws:: java.io.IOException - Indicates that the method encountered a problem importing the XML.; org.xml.sax.SAXException - Indicates that the method encountered a problem parsing the XML.

importXML

public final java.util.List importXML(java.lang.String inXML,
                                      MdmDatabaseSchema destinationSchema,
                                      boolean modifyIfExists,
                                      java.util.Map<java.lang.String,java.lang.String> bindValues,
                                      XMLParserCallback parserCallback)
                               throws java.io.IOException,
                                      org.xml.sax.SAXException

Parameters:: inXML - A String that contains the XML.; destinationSchema - The MdmDatabaseSchema to contain the new or modified objects.; modifyIfExists - A boolean that indicates whether or not modify an existing object.; bindValues - A Map that has keys that are bind variables and values that are String objects that contain the values with which to replace the bind variables.; parserCallback - An XMLParserCallback that specifies how the XML parser should handle error conditions.
Returns:: A List that contains the objects defined by the imported XML.
Throws:: java.io.IOException - Indicates that the method encountered a problem importing the XML.; org.xml.sax.SAXException - Indicates that the method encountered a problem parsing the XML.

importXML

public final java.util.List importXML(java.lang.String inXML,
                                      MdmDatabaseSchema destinationSchema,
                                      boolean modifyIfExists,
                                      java.util.Map<java.lang.String,java.lang.String> bindValues)
                               throws java.io.IOException,
                                      org.xml.sax.SAXException

Imports XML representations of objects that belong to the specified MdmDatabaseSchema, creates new objects or modifies existing objects, and replaces bind variables in the XML with values.

Parameters:: inXML - A String that contains the XML.; destinationSchema - The MdmDatabaseSchema to contain the new or modified objects.; modifyIfExists - A boolean that indicates whether or not modify an existing object.; bindValues - A Map that has keys that are bind variables and values that are String objects that contain the values with which to replace the bind variables.
Returns:: A List that contains the objects defined by the imported XML.
Throws:: java.io.IOException - Indicates that the method encountered a problem importing the XML.; org.xml.sax.SAXException - Indicates that the method encountered a problem parsing the XML.

importXML

public final java.util.List importXML(java.lang.String inXML,
                                      MdmDatabaseSchema destinationSchema,
                                      boolean modifyIfExists)
                               throws java.io.IOException,
                                      org.xml.sax.SAXException

Imports XML representations of objects that belong to the specified MdmDatabaseSchema and either creates new objects or modifies existing objects.

Parameters:: inXML - A String that contains the XML.; destinationSchema - The MdmDatabaseSchema to contain the new or modified objects.; modifyIfExists - A boolean that indicates whether to modify an existing object.
Returns:: A List that contains the objects defined by the imported XML.
Throws:: java.io.IOException - Indicates that the method encountered a problem importing the XML.; org.xml.sax.SAXException - Indicates that the method encountered a problem parsing the XML.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.olapi.metadata.mdm Class MdmMetadataProvider

getMetadataObject

getMetadataObjects

getRootSchema

getMdmCustomObjectFactory

getMtmCustomObjectFactory

setMdmNamingConvention

getMtmDataTypeConverter

setMtmDataTypeConverter

exportFullXML

exportFullXML

exportFullXML

exportFullXML

exportFullXML

exportFullXML

exportFullXML

exportFullXML

exportFullXML

exportFullXML

exportIncrementalXML

exportIncrementalXML

exportIncrementalXML

exportIncrementalXML

exportIncrementalXML

exportIncrementalXML

exportIncrementalXML

exportIncrementalXML

exportIncrementalXML

exportIncrementalXML

importXML

importXML

importXML

importXML

importXML

importXML

oracle.olapi.metadata.mdm
Class MdmMetadataProvider