|
| Metadata |
|
| |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||||
@SASScope(value="ALL") public interface MdOMIUtil
Used to perform operations against the metadata server, such as querying and deleting objects. This interface wraps the methods available in the IOMI interface.
To retrieve the instance of this interface, see:
MdFactory.getOMIUtil()
This class depends on objects being contained in an object store.
A connection to the metadata server must be established first before using any of the methods on
this interface. To create a connection, use MdOMRConnection.
com.sas.metadata.remote| Field Summary | |
|---|---|
static java.lang.String |
CLASSID_FTP
The class ID for a FTP server: CBA26437-1577-4FF8-93F6-9B68B4DD8D2E |
static java.lang.String |
CLASSID_HTTP
The Class ID for a HTTP server: DAC0D7F0-10DA-11D6-8816- AA0004006D06 |
static java.lang.String |
CLASSID_MESSAGEQUEUE_JMS
The class ID for a JMS Message Queue Manager: "MessageQueue.JMS" |
static java.lang.String |
CLASSID_MESSAGEQUEUE_MS
The class ID for a Message Queue: "MessageQueue.MSMQ" |
static java.lang.String |
CLASSID_MESSAGEQUEUE_WEBSPHERE
The class ID for a Message Queue: "MessageQueue.Websphere" |
static java.lang.String |
CLSID_SAS_POOLED_WORKSPACE
The class ID for a Pooled Workspace Server: 620963ee-32bf-4128-bf5f-4b0df8ff90eb |
static java.lang.String |
CLSID_SAS_WORKSPACE
The class id of the classic SAS server: 440196d4-90f0-11d0-9f41-00a024bb830c |
static java.lang.String |
CLSID_SASGMS_GMS
The class id of the generic server: 9c186a64-83e4-11d2-b956-00c04f81993c |
static java.lang.String |
CLSID_SASMDX_SERVER
The class id of OLAP V9: f3f46472-1e31-11d5-87c2-00c04f38f9f6 |
static java.lang.String |
CLSID_SASMQX_MQX
the class id of the message queue server: 8d9ef489-8d1e-11d2-b94f-00c04f8198c0 |
static java.lang.String |
CLSID_SASOMI_OMI
The class id of the OMR server: 2887e7d7-4780-11d4-879f-00c04f38f0db |
static java.lang.String |
CLSID_SASSTP_STOREDPROCESSSERVER
The class id of SAS/Intrnet V9: 15931e31-667f-11d5-8804-00c04f35ac8c |
static java.lang.String |
FOLDERTYPE_APPDATA
The user's application data folder |
static java.lang.String |
FOLDERTYPE_HOME
The user's home folder |
static java.lang.String |
FOLDERTYPE_MYFOLDER
The user's "my folder" |
static int |
OMI_ALL
(1) specifies that the method get all of the properties of the requested object. |
static int |
OMI_ALL_DESCENDANTS
(64) Returns all subtypes along with all of their descendants |
static int |
OMI_ALL_SIMPLE
(8) specifies that the method get all of the attributes of the requested object. |
static int |
OMI_CI_DELETE_ALL
Deprecated. As of 9.2, no longer supported by the metadata server |
static int |
OMI_CI_NODELETE
Deprecated. As of 9.2, no longer supported by the metadata server |
static int |
OMI_CLIENT_ID
(8388608) Client is supplying repository ID on AddMetadata of REPOS. |
static int |
OMI_DELETE
(32) Deletes the files in a repository in addition to the repository registration. |
static int |
OMI_DEPENDENCY_USEDBY
(16384) In GetMetadata, specifies to look for cross-repository references in repositories that use the current repository. |
static int |
OMI_DEPENDENCY_USES
(8192) Specifies to retrieve objects of the passed type from all repositories that have a DependencyUses dependency |
static int |
OMI_EXPAND
Deprecated. no longer supported by the metadata server |
static int |
OMI_FULL_OBJECT
(2) Instructs the SAS Metadata Server to use a public object type definition from the Object Type Dictionary to expand the specified object's logical metadata definition. |
static int |
OMI_GET_ID
Deprecated. |
static int |
OMI_GET_METADATA
(256) Specifies to execute a GetMetadata call for each object that is returned by the GetMetadataObjects request. |
static int |
OMI_GET_OBJREF
(4096) |
static int |
OMI_IGNORE_NOTFOUND
(134217728) This flag is for DeleteMetadata to tell it to ignore objects not found so that it will not return on error. |
static int |
OMI_INCLUDE_SUBTYPES
(16) Specifies to retrieve metadata objects that are subtypes of the passed metadata type in addition to objects of the passed type. |
static int |
OMI_LOCK
(32768) Locks the specified object and any associated objects selected by GetMetadata flags and options from update by other users. |
static int |
OMI_LOCK_TEMPLATE
Deprecated. As of 9.2, no longer supported by the metadata server |
static int |
OMI_MATCH_CASE
(512) Specifies to perform a case-sensitive search of the criteria specified in the |
static int |
OMI_MULT_REQUEST
(1073741824) |
static int |
OMI_NOFORMAT
(67108864) Do not format time values returned from the server. |
static int |
OMI_PURGE
Deprecated. As of 9.2, no longer supported by the metadata server |
static int |
OMI_REINIT
(2097152) Deletes the contents of a repository but does not remove the repository's registration from the repository manager. |
static int |
OMI_RETURN_LIST
(1024) Returns a list of deleted object IDs, as well as any cascading object IDs that were deleted. |
static int |
OMI_SUCCINCT
(2048) specifies to omit properties that do not contain values or that contain null values. |
static int |
OMI_TEMPLATE
(4) checks the Options parameter for one or more user-defined templates that specify the properties to return for a given metadata type. |
static int |
OMI_TRUNCATE
(4194304) Deletes all metadata objects but does not remove the metadata object containers from a repository or change the repository's registration. |
static int |
OMI_TRUSTED_CLIENT
(268435456)Determines if the client can call this method. |
static int |
OMI_UNLOCK
(131072) Unlocks the specified object and any associated objects that were locked when the update is completed |
static int |
OMI_UNLOCK_FORCE
(262144) Unlocks any locks held by another user so that a metadata object can be updated. |
static int |
OMI_XMLSELECT
(128) Checks the Options parameter for criteria to qualify the objects that are returned by the server. |
| Method Summary | |
|---|---|
abstract int |
addMetadata(java.lang.String inXML,
java.lang.String reposID,
org.omg.CORBA.StringHolder outXML,
int iFlags)
Performs an add operation against the metadata server. |
abstract org.w3c.dom.Document |
ApplyXML(java.lang.String inXML,
java.lang.String reposID)
This routine is used by metadata importers to filter their XML to handle XML updates. |
abstract java.lang.String |
cleanStringForXML(java.lang.String s)
Note: As of 9.4, callers can now use the static method XMLUtil.normalize(String) instead. |
abstract java.lang.String |
createGetXMLString(java.util.Map<java.lang.String,java.lang.String> objectMap)
Creates and returns the XML string used for a GetMetadata request. |
abstract java.lang.String |
createGetXMLString(java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> simpleAttr,
java.util.List<java.lang.String> complexAttr)
Creates and returns the XML string to retrieve simple and/or complex attributes. |
abstract java.lang.String |
createObjectAttributeString(java.util.Map<java.lang.String,java.lang.String> attributes)
Creates a string of an object's attributes as key/value pairs |
abstract java.lang.String |
createRefreshXML(CMetadata meta,
boolean refreshAssocsSetByServerOnly,
boolean refreshAll)
Creates an XML string used for refreshing an object. |
abstract java.lang.String |
createUpdateXMLSimple(java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> attributes,
java.util.List<java.lang.String> values)
Creates and returns the XML string of the passed in attributes |
abstract java.lang.String |
createXMLSubString(java.util.List<java.lang.String> attributes,
java.util.List<java.lang.String> values)
Creates and returns the XML string of the passed in attributes |
abstract java.util.List<java.lang.String> |
deleteMetadataObject(CMetadata inObject)
Delete a CMetadata object and all it's dependancies. |
abstract java.util.List<java.lang.String> |
deleteMetadataObject(CMetadata metadataObject,
java.lang.String template)
Deletes an object from the server using the specified delete template. |
abstract java.util.List<java.lang.String> |
deleteMetadataObject(java.lang.String objectType,
java.lang.String objectID)
Deletes a metadata object and all of its dependencies |
abstract java.util.List<java.lang.String> |
deleteMetadataObject(java.lang.String objectType,
java.lang.String objectID,
java.lang.String template)
Deletes a metadata object and all of its dependencies |
abstract java.util.List<java.lang.String> |
deleteMetadataObjects(java.util.List<? extends CMetadata> inObjects)
Delete a CMetadata object and all it's dependancies. |
abstract java.util.List<java.lang.String> |
deleteMetadataObjects(java.util.Map<java.lang.String,java.lang.String> inObjects)
Delete multiple objects from the server and all their dependencies. |
abstract int |
doesObjectExist(java.lang.String reposID,
java.lang.String objectType,
java.lang.String xmlSelect)
Returns whether an object exists on the metadata server. |
abstract org.w3c.dom.Document |
DoRequest(java.lang.String inXML)
Performs a DoRequest |
abstract org.w3c.dom.Document |
DoRequest(java.lang.String inXML,
boolean fUpdateIds)
Performs a DoRequest |
abstract void |
DoRequestNoReturn(java.lang.String inXML,
boolean fUpdateIds)
Performs a DoRequest |
abstract CMetadata |
doSimple(CMetadata thisObject,
org.w3c.dom.NamedNodeMap thisNodeMap)
Calls 'set' methods for given object for nodes in given NodeMap |
abstract java.lang.String |
formatXML(java.lang.String original)
Note: As of 9.4, callers can now use the static method XMLUtil.formatXML(String) instead. |
abstract CMetadata |
getAssociatedObject(CMetadata object,
java.lang.String strAssociation,
java.lang.String strTemplate)
Get the single metatdata object from the given associtation. |
abstract CMetadata |
getAssociatedObject(CMetadata object,
java.lang.String strAssociation,
java.lang.String strTemplate,
boolean doNotOverrideAssocs)
Get the single metatdata object from the given associtation. |
abstract AssociationList |
getAssociatedObjects(CMetadata object,
java.lang.String strAssociation,
java.lang.String strTemplate)
Gets the list of metatdata objects for the given association. |
abstract AssociationList |
getAssociatedObjects(CMetadata object,
java.lang.String strAssociation,
java.lang.String strTemplate,
boolean doNotOverrideAssocs)
Gets the list of metatdata objects for the given association. |
abstract java.lang.String |
getAttribute(java.lang.String strAttribute,
org.w3c.dom.NamedNodeMap childNodeMap)
Retrieve the requested attribute from the XML dom object. |
abstract java.util.List<FastMetadata> |
getFastMetadata(java.util.Map<java.lang.String,java.lang.String> objects,
java.lang.String options,
int flags)
Returns lightweight descriptions of metadata objects. |
abstract FastMetadata |
getFastMetadata(java.lang.String metadataType,
java.lang.String fqid,
java.lang.String options,
int flags)
Returns a lightweight description of a metadata object. |
abstract java.util.List<FastMetadata> |
getFastMetadataObjects(java.lang.String strType,
java.lang.String strReposId,
java.lang.String strOptions,
int iFlags)
Returns lightweight descriptions of metadata objects retrieved by a server GetMetadataObjects request. |
abstract java.lang.String |
getFoundationReposID()
Returns the ID of the Foundation repository |
abstract CMetadata |
getFoundationRepository()
Returns the foundation repository for the connected metadata server. |
abstract CMetadata |
getFullObject(MdObjectStore store,
CMetadata meta)
Performs a GetMetadata request on an existing public object. |
abstract CMetadata |
getFullObject(MdObjectStore store,
java.lang.String objectType,
java.lang.String objectID)
Performs a GetMetadata request on an existing public object. |
abstract java.util.List |
getFullObjects(MdObjectStore store,
java.util.Map<java.lang.String,java.lang.String> objectMap)
Performs a GetMetadata request on a set of existing public objecst. |
abstract Identity |
getIdentity(MdObjectStore store)
This routine is used to retrieve the identity object of the current user. |
abstract java.util.List |
getMetadata(MdStore store,
java.util.Map objectMap,
java.lang.String template,
int flags)
Performs a GetMetadata request for a group of objects. |
abstract java.util.List |
getMetadata(MdStore store,
java.util.Map objectMap,
java.lang.String template,
int flags,
boolean doNotOverrideAssocs,
boolean doNotOverrideAttrs)
Performs a GetMetadata request for a group of objects. |
abstract org.w3c.dom.Document |
getMetadata(java.lang.String inXML,
int iFlags)
Sends input XML string to metadata server, and parses the output XML into a DOM document. |
abstract org.w3c.dom.Document |
getMetadata(java.lang.String inXML,
java.lang.String strTemplate,
int iFlags)
Sends input and template XML strings to metadata server, and parses the output XML into a DOM document. |
abstract CMetadata |
getMetadataAllDepths(CMetadata object,
java.util.List<java.lang.String> inSimpleAttr,
java.util.List<java.lang.String> inComplexObject,
java.lang.String strTemplate,
int iOptions)
This method constructs CMetadata objects and sets both simple and complex attributes. |
abstract CMetadata |
getMetadataAllDepths(CMetadata object,
java.util.List<java.lang.String> inSimpleAttr,
java.util.List<java.lang.String> inComplexObject,
java.lang.String strTemplate,
int iOptions,
boolean doNotOverrideAssocs)
This method constructs CMetadata objects and sets both simple and complex attributes. |
abstract CMetadata |
getMetadataAllDepths(MdStore inStore,
java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> inSimpleAttr,
java.util.List<java.lang.String> inComplexObject,
java.lang.String strTemplate,
int iOptions)
This method constructs CMetadata objects and sets both simple and complex attributes. |
abstract CMetadata |
getMetadataAllDepths(MdStore inStore,
java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> inSimpleAttr,
java.util.List<java.lang.String> inComplexObject,
java.lang.String strTemplate,
int iOptions,
boolean doNotOverrideAssocs)
This method constructs CMetadata objects and sets both simple and complex attributes. |
abstract java.util.List |
getMetadataNoCache(java.util.Map objectMap,
java.lang.String strOptions,
int iFlags)
Deprecated. This method has been replaced by getFastMetadata(Map, String, int). |
abstract java.util.Map |
getMetadataNoCache(java.lang.String strType,
java.lang.String strFQID,
java.lang.String strOptions,
int iFlags)
Deprecated. This method has been replaced by getFastMetadata(Map, String, int). |
abstract java.util.List |
getMetadataObjects(MdStore inStore,
java.lang.String inXML,
java.lang.String strTemplate,
int iFlags)
Sends input and template XML strings to metadata server, and parses the output XML into a List of objects contained in the inStore. |
abstract java.util.List |
getMetadataObjects(MdStore inStore,
java.lang.String inXML,
java.lang.String strTemplate,
int iFlags,
boolean doNotOverrideAssocs)
Sends input and template XML strings to metadata server, and parses the output XML into a List of objects contained in the inStore. |
abstract java.util.List |
getMetadataObjects(java.lang.String strReposID,
java.lang.String strType)
Gets the list of metatdata objects in the repository for the requested type. |
abstract java.util.List |
getMetadataObjects(java.lang.String strReposID,
java.lang.String strType,
int iFlags)
Gets the list of metatdata objects in the repository for the requested type. |
abstract java.util.List |
getMetadataObjects(java.lang.String strReposID,
java.lang.String strType,
int flags,
java.lang.String strOptions)
Gets the list of metatdata objects in the repository for the requested type. |
abstract java.util.List |
getMetadataObjectsNoCache(java.lang.String strType,
java.lang.String strReposId,
java.lang.String strOptions,
int iFlags)
Deprecated. This method has been replaced by getFastMetadataObjects(String, String, String, int). |
abstract java.util.List |
getMetadataObjectsSubset(MdStore inStore,
java.lang.String strReposID,
java.lang.String strType,
int flags,
java.lang.String options)
Gets the list of metatdata objects in the repository for the requested type. |
abstract java.util.List |
getMetadataObjectsSubset(MdStore inStore,
java.lang.String strReposID,
java.lang.String strType,
int flags,
java.lang.String options,
boolean doOverrideAssocs)
Gets the list of metatdata objects in the repository for the requested type. |
abstract java.util.List |
getMetadataObjectsSubsetList(MdStore inStore,
java.lang.String strReposID,
java.lang.String strType,
int flags,
java.lang.String options,
boolean doOverrideAssocs)
Gets the list of metatdata objects in the repository for the requested type. |
abstract java.util.List<java.lang.String> |
getMetadataSimple(java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> attributes)
Returns a List of the simple attributes requested; these objects have been parsed and are returned as Strings in the order they were requested |
abstract java.lang.String |
getMetadataSimple(java.lang.String strType,
java.lang.String strFQID,
java.lang.String attributeName)
Returns a single attribute value from the server. |
abstract java.lang.String |
getNamespace()
Returns the current namespace used for OMI interactions |
abstract java.lang.String |
getObjectPath(MdObjectStore store,
PrimaryType meta,
boolean includeType)
Returns the path of the specified public object. |
abstract java.lang.String |
getReposIdFromMetadataObject(CMetadata meta)
Returns the fully qualified repository id for a given metadata object (A0000001.XXXXXXXX). |
abstract java.util.List<CMetadata> |
getRepositories()
Reads all repositories registered in the Common Metadata Repository Manager. |
abstract ResponsibleParty |
getResponsibleParty(MdObjectStore store,
java.lang.String identityName,
java.lang.String responsibility)
Returns a responsible party object for a given identity and responsibility. |
abstract ResponsibleParty |
getResponsibleParty(MdObjectStore store,
java.lang.String identityName,
java.lang.String responsibility,
java.lang.String template,
int flags)
Returns a responsible party object for a given identity and responsibility. |
abstract java.util.List<java.lang.String> |
getSubTypes(java.lang.String objectType,
boolean includeDescendants)
Gets the subtypes specific metadata object type. |
abstract void |
getTypeProperties(java.lang.String objectType,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> attributeMap,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> associationMap)
Gets the properties for a specific metadata object type. |
abstract void |
getTypes(java.util.List<java.lang.String> nameList,
java.util.List<java.lang.String> descList)
Gets the types that are available in the repository. |
abstract Tree |
getUserHomeFolder(MdObjectStore store,
java.lang.String userName,
java.lang.String folderName,
java.lang.String template,
int flags)
Returns a home folder for a given user. |
abstract Tree |
getUserHomeFolder(MdObjectStore store,
java.lang.String userName,
java.lang.String folderName,
java.lang.String template,
int flags,
boolean createIfNecessary)
Returns a home folder for a given user. |
abstract java.lang.String |
getUserHomeFolderName(java.lang.String userName,
java.lang.String folderName)
Returns the localized name of a user's home folder. |
abstract org.w3c.dom.Document |
parseXML(java.lang.String strXML)
routine to parse a passed in xml string and return a dom document |
abstract org.w3c.dom.Document |
parseXML(java.net.URL xmlDocument)
routine to parse a passed in xml URL and return a dom document |
abstract org.w3c.dom.Document |
parseXML(java.net.URL xmlDocument,
java.util.Map<java.lang.String,java.lang.Boolean> features)
routine to parse a passed in xml URL and return a dom document |
abstract CMetadata |
populateObject(CMetadata metaObject,
org.w3c.dom.NamedNodeMap simpleNodeMap,
org.w3c.dom.NodeList complexNodeList)
Populates an objects simple and complex attributes, by what is in the simpleNodeMap and the complexNodeList. |
abstract CMetadata |
populateObject(CMetadata metaObject,
org.w3c.dom.NamedNodeMap simpleNodeMap,
org.w3c.dom.NodeList complexNodeList,
boolean doNotOverrideAssocs)
Populates an objects simple and complex attributes, by what is in the simpleNodeMap and the complexNodeList. |
abstract java.util.List |
populateObjects(CMetadata metaObject,
org.w3c.dom.NamedNodeMap simpleNodeMap,
org.w3c.dom.NodeList complexNodeList,
boolean doNotOverrideAssocs,
java.util.List objects)
Populates an objects simple and complex attributes, by what is in the simpleNodeMap and the complexNodeList. |
abstract void |
populateStoreFromInputStream(MdStore inStore,
java.io.InputStream stream,
int state,
boolean useReposForNewObjects)
Build objects from an input stream and set states to desired state. |
abstract void |
populateStoreFromString(MdStore inStore,
org.w3c.dom.Document doc,
int state,
boolean useReposForNewObjects)
Build objects from source XML and set states to desired state. |
abstract void |
populateStoreFromString(MdStore inStore,
java.lang.String inXML,
int state,
boolean useReposForNewObjects)
Build objects from source XML and set states to desired state. |
abstract void |
processDeletedObjects(org.w3c.dom.Document outDoc)
This deletes objects on the client that have been deleted from the server and are returned from a DeltedObjects array. |
abstract void |
setNamespace(java.lang.String newNamespace)
Sets the current namespace used for OMI interactions |
abstract void |
setObjectAssociations(CMetadata metaObject,
java.util.List outComplexNames,
java.util.List[] outComplexObjects,
boolean doNotOverrideAssns)
Call given object's 'set...s' methods for the given complex attributes |
abstract void |
updateMetadata(java.lang.String inXML)
|
abstract int |
updateMetadata(java.lang.String inXML,
org.omg.CORBA.StringHolder outXML,
int iFlags)
Performs an update operation against the metadata server. |
abstract void |
updateMetadataSimple(java.lang.String inXML)
|
abstract void |
updateMetadataSimple(java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> attributes,
java.util.List<java.lang.String> values)
Updates the values of the simple attributes given. |
abstract void |
updateObjectId(org.w3c.dom.Document inDoc,
org.w3c.dom.Document outDoc)
Updates the object ids on the local server stores to reflect the new id on the server. |
| Field Detail |
|---|
static final java.lang.String FOLDERTYPE_HOME
static final java.lang.String FOLDERTYPE_MYFOLDER
static final java.lang.String FOLDERTYPE_APPDATA
static final int OMI_ALL
static final int OMI_EXPAND
static final int OMI_FULL_OBJECT
static final int OMI_TEMPLATE
static final int OMI_ALL_SIMPLE
static final int OMI_INCLUDE_SUBTYPES
static final int OMI_DELETE
static final int OMI_CI_DELETE_ALL
static final int OMI_ALL_DESCENDANTS
static final int OMI_XMLSELECT
static final int OMI_GET_METADATA
static final int OMI_MATCH_CASE
static final int OMI_RETURN_LIST
static final int OMI_SUCCINCT
static final int OMI_GET_OBJREF
static final int OMI_DEPENDENCY_USES
static final int OMI_DEPENDENCY_USEDBY
static final int OMI_LOCK
static final int OMI_LOCK_TEMPLATE
static final int OMI_UNLOCK
static final int OMI_UNLOCK_FORCE
static final int OMI_CI_NODELETE
static final int OMI_PURGE
static final int OMI_REINIT
static final int OMI_TRUNCATE
static final int OMI_CLIENT_ID
static final int OMI_NOFORMAT
static final int OMI_IGNORE_NOTFOUND
static final int OMI_TRUSTED_CLIENT
static final int OMI_GET_ID
static final int OMI_MULT_REQUEST
static final java.lang.String CLSID_SAS_WORKSPACE
static final java.lang.String CLSID_SASSTP_STOREDPROCESSSERVER
static final java.lang.String CLSID_SASOMI_OMI
static final java.lang.String CLSID_SASMDX_SERVER
static final java.lang.String CLSID_SASGMS_GMS
static final java.lang.String CLSID_SASMQX_MQX
static final java.lang.String CLASSID_HTTP
static final java.lang.String CLASSID_FTP
static final java.lang.String CLASSID_MESSAGEQUEUE_MS
static final java.lang.String CLASSID_MESSAGEQUEUE_WEBSPHERE
static final java.lang.String CLSID_SAS_POOLED_WORKSPACE
static final java.lang.String CLASSID_MESSAGEQUEUE_JMS
| Method Detail |
|---|
java.lang.String getNamespace()
throws java.rmi.RemoteException
java.rmi.RemoteException
void setNamespace(java.lang.String newNamespace)
throws java.rmi.RemoteException
newNamespace - String
java.rmi.RemoteException
java.lang.String getReposIdFromMetadataObject(CMetadata meta)
throws java.rmi.RemoteException
meta - the metadata object
java.rmi.RemoteException
CMetadata getFoundationRepository()
throws MdException,
java.rmi.RemoteException
CMetadata
object is returned. If a foundation repository cannot be found, a null is returned.
MdException
java.rmi.RemoteException
java.util.List<CMetadata> getRepositories()
throws MdException,
java.rmi.RemoteException
MdException - in the case of any server errors
java.rmi.RemoteException
CMetadata getFullObject(MdObjectStore store,
CMetadata meta)
throws MdException,
java.rmi.RemoteException
This method is mainly a convenience method for retrieving the full metadata representation of
a public object, without requiring you to know which associations need to be passed in via a
template. All information for the public object, including all of its attributes
as well as all of its subordinate objects will be retrieved. The method does not require
any flags or templates to be passed in as they (OMI_FULL_OBJECT,
OMI_ALL_SIMPLE, and OMI_SUCCINCT) are automatically
passed to the server for you.
Note: this method will always overwrite any attributes and associations that may already be set on the object.
store - the store to create the object(s) inmeta - the metadata object to query
MdException
java.rmi.RemoteException
CMetadata getFullObject(MdObjectStore store,
java.lang.String objectType,
java.lang.String objectID)
throws MdException,
java.rmi.RemoteException
This method is mainly a convenience method for retrieving the full metadata representation of
a public object, without requiring you to know which associations need to be passed in via a
template. All information for the public object, including all of its attributes
as well as all of its subordinate objects will be retrieved. The method does not require
any flags or templates to be passed in as they (OMI_FULL_OBJECT,
OMI_ALL_SIMPLE, and OMI_SUCCINCT) are automatically
passed to the server for you.
Note: if the object exists within the object store prior to calling this method, all of its attributes and associations will be overwritten.
store - the store to create the object(s) inobjectType - the metadata type of the objectobjectID - the object id
MdException
java.rmi.RemoteException
java.util.List getFullObjects(MdObjectStore store,
java.util.Map<java.lang.String,java.lang.String> objectMap)
throws MdException,
java.rmi.RemoteException
This method is mainly a convenience method for retrieving the full metadata representation of
the public objects, without requiring you to know which associations need to be passed in via a
template. All information for the public objects, including all of its attributes
as well as all of its subordinate objects will be retrieved. The method does not require
any flags or templates to be passed in as they (OMI_FULL_OBJECT,
OMI_ALL_SIMPLE, and OMI_SUCCINCT) are automatically
passed to the server for you.
Note: if an object exists within the object store prior to calling this method, all of its attributes and associations will be overwritten.
store - the store to create the object(s) inobjectMap - map of the objects to retrieve from the server. Keys for the map must be the
metadata object ids, and the values must be the metadata object types.
MdException
java.rmi.RemoteException
java.lang.String getMetadataSimple(java.lang.String strType,
java.lang.String strFQID,
java.lang.String attributeName)
throws MdException,
java.rmi.RemoteException
strType - Type of Metadata object we are fetching the data forstrFQID - Unique ID of the metadata object we are fetching the data forattributeName - the name of the attribute to retrieve (ex. MdFactory.NAME or MdFactory.DESC)
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List<java.lang.String> getMetadataSimple(java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> attributes)
throws MdException,
java.rmi.RemoteException
strType - - Type of Metadata object we are fetching the data for (WTABLE, WCOLUMN, etc.)
NOTE: CASE SENSITIVE!!!!strFQID - - Unique ID of the metadata object we are fetching the data forattributes - - List of Strings containing the names of the attributes to
fetch NOTE: CASE SENSITIVE! USE THE STATIC VARS in m_factory
MdException - in the case of any server errors
java.rmi.RemoteException
CMetadata getMetadataAllDepths(CMetadata object,
java.util.List<java.lang.String> inSimpleAttr,
java.util.List<java.lang.String> inComplexObject,
java.lang.String strTemplate,
int iOptions)
throws MdException,
java.rmi.RemoteException
object - - Metadata object to get data forinSimpleAttr - - list of the simple attributes to fetch for this object
you dont need any if you dont want any; Also, if you pass in an empty List, and set the
iOptions field to OMI_ALL | OMI_ALL_SIMPLE (9) you can get back all the simple attributes for
this metadata object. inSimpleAttr will be filled in with the attribute name, and outSimpleAttr will
contain the attribute value.inComplexObject - - list of the complex objects to get for this object (WCOLUMN, JOB, etc.)strTemplate - - the template you want to apply to this objectiOptions - - Options to pass in with this call to the server. Valid values are defined as:
MdException - in the case of any server errors
java.rmi.RemoteException
CMetadata getMetadataAllDepths(CMetadata object,
java.util.List<java.lang.String> inSimpleAttr,
java.util.List<java.lang.String> inComplexObject,
java.lang.String strTemplate,
int iOptions,
boolean doNotOverrideAssocs)
throws MdException,
java.rmi.RemoteException
object - - Metadata object to get data forinSimpleAttr - - list of the simple attributes to fetch for this object
you dont need any if you dont want any; Also, if you pass in an empty List, and set the
iOptions field to OMI_ALL | OMI_ALL_SIMPLE (9) you can get back all the simple attributes for
this metadata object. inSimpleAttr will be filled in with the attribute name, and outSimpleAttr will
contain the attribute value.inComplexObject - - list of the complex objects to get for this object (WCOLUMN, JOB, etc.)strTemplate - - the template you want to apply to this objectiOptions - - Options to pass in with this call to the server. Valid values are defined as:
MdException - in the case of any server errors
java.rmi.RemoteException
CMetadata getMetadataAllDepths(MdStore inStore,
java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> inSimpleAttr,
java.util.List<java.lang.String> inComplexObject,
java.lang.String strTemplate,
int iOptions)
throws MdException,
java.rmi.RemoteException
inStore - MdStore the store to create new objects into.strType - - Type of Metadata object we are fetching the data for (WTABLE, WCOLUMN, etc.)
NOTE: CASE SENSITIVE!!!!strFQID - - Unique ID of the metadata object we are fetching the data forinSimpleAttr - - list of the simple attributes to fetch for this object
you dont need any if you dont want any; Also, if you pass in an empty List, and set the
iOptions field to OMI_ALL | OMI_ALL_SIMPLE (9) you can get back all the simple attributes for
this metadata object. inSimpleAttr will be filled in with the attribute name, and outSimpleAttr will
contain the attribute value.inComplexObject - - list of the complex objects to get for this object (WCOLUMN, JOB, etc.)strTemplate - - the template you want to apply to this objectiOptions - - Options to pass in with this call to the server. Valid values are defined as:
MdException - in the case of any server errors
java.rmi.RemoteException
CMetadata getMetadataAllDepths(MdStore inStore,
java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> inSimpleAttr,
java.util.List<java.lang.String> inComplexObject,
java.lang.String strTemplate,
int iOptions,
boolean doNotOverrideAssocs)
throws MdException,
java.rmi.RemoteException
inStore - MdStore the store to create new objects into.strType - - Type of Metadata object we are fetching the data for (WTABLE, WCOLUMN, etc.)
NOTE: CASE SENSITIVE!!!!strFQID - - Unique ID of the metadata object we are fetching the data forinSimpleAttr - - list of the simple attributes to fetch for this object
you dont need any if you dont want any; Also, if you pass in an empty List, and set the
iOptions field to OMI_ALL | OMI_ALL_SIMPLE (9) you can get back all the simple attributes for
this metadata object. inSimpleAttr will be filled in with the attribute name, and outSimpleAttr will
contain the attribute value.inComplexObject - - list of the complex objects to get for this object (WCOLUMN, JOB, etc.)strTemplate - - the template you want to apply to this objectiOptions - - Options to pass in with this call to the server. Valid values are defined as:
MdException - in the case of any server errors
java.rmi.RemoteException
void populateStoreFromString(MdStore inStore,
org.w3c.dom.Document doc,
int state,
boolean useReposForNewObjects)
throws MdException,
java.rmi.RemoteException
inStore - the store to create the objects indoc - the xml document containing the metadata to createstate - Valid states are MetadataState.LOCAL & MetadataState.SERVER
MdException - If error getting/setting data on object.
java.rmi.RemoteException
void populateStoreFromString(MdStore inStore,
java.lang.String inXML,
int state,
boolean useReposForNewObjects)
throws MdException,
java.rmi.RemoteException
inStore - the store to create the objects ininXML - the xml containing the metadata to createstate - Valid states are MetadataState.LOCAL & MetadataState.SERVER
MdException - If error getting/setting data on object.
java.rmi.RemoteException
void populateStoreFromInputStream(MdStore inStore,
java.io.InputStream stream,
int state,
boolean useReposForNewObjects)
throws MdException,
java.rmi.RemoteException
inStore - the store to create the objects instream - The input stream containing the xml to be parsedstate - Valid states are MetadataState.LOCAL & MetadataState.SERVER
MdException - If error getting/setting data on object.
java.rmi.RemoteException
CMetadata populateObject(CMetadata metaObject,
org.w3c.dom.NamedNodeMap simpleNodeMap,
org.w3c.dom.NodeList complexNodeList)
throws MdException,
java.rmi.RemoteException
metaObject - CMetadatasimpleNodeMap - org.w3c.dom.NamedNodeMapcomplexNodeList - org.w3c.dom.NodeList
MdException - in the case of any server errors
java.rmi.RemoteException
CMetadata populateObject(CMetadata metaObject,
org.w3c.dom.NamedNodeMap simpleNodeMap,
org.w3c.dom.NodeList complexNodeList,
boolean doNotOverrideAssocs)
throws MdException,
java.rmi.RemoteException
metaObject - CMetadatasimpleNodeMap - org.w3c.dom.NamedNodeMapcomplexNodeList - org.w3c.dom.NodeList
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List populateObjects(CMetadata metaObject,
org.w3c.dom.NamedNodeMap simpleNodeMap,
org.w3c.dom.NodeList complexNodeList,
boolean doNotOverrideAssocs,
java.util.List objects)
throws MdException,
java.rmi.RemoteException
metaObject - CMetadatasimpleNodeMap - org.w3c.dom.NamedNodeMapcomplexNodeList - org.w3c.dom.NodeList
MdException - in the case of any server errors
java.rmi.RemoteException
CMetadata doSimple(CMetadata thisObject,
org.w3c.dom.NamedNodeMap thisNodeMap)
throws MdException,
java.rmi.RemoteException
thisObject - CMetadatathisNodeMap - org.w3c.dom.NamedNodeMap
MdException - in the case of any errors in reflection setting values
java.rmi.RemoteException
void setObjectAssociations(CMetadata metaObject,
java.util.List outComplexNames,
java.util.List[] outComplexObjects,
boolean doNotOverrideAssns)
throws MdException,
java.rmi.RemoteException
metaObject - CMetadataoutComplexNames - ListoutComplexObjects - List[]
MdException - if error in reflection.
java.rmi.RemoteException
java.lang.String getUserHomeFolderName(java.lang.String userName,
java.lang.String folderName)
throws java.rmi.RemoteException
This method is guaranteed to at least return the original folder name if the localized version can't be found.
userName - the name of th euserfolderName - the type of folder to return. Valid values are:
java.rmi.RemoteException
Tree getUserHomeFolder(MdObjectStore store,
java.lang.String userName,
java.lang.String folderName,
java.lang.String template,
int flags)
throws MdException,
java.rmi.RemoteException
store - the object store to create the folder inuserName - the name of the userfolderName - the type of folder to return. Valid values are:
template - the template to apply to this folderflags -
MdException
java.rmi.RemoteException
Tree getUserHomeFolder(MdObjectStore store,
java.lang.String userName,
java.lang.String folderName,
java.lang.String template,
int flags,
boolean createIfNecessary)
throws MdException,
java.rmi.RemoteException
store - the object store to create the folder inuserName - the name of the userfolderName - the type of folder to return. Valid values are:
template - the template to apply to this folderflags - createIfNecessary - if true, the folder will be created if it doesn't yet exist. Otherwise, if false,
the folder will not be created.
MdException
java.rmi.RemoteException
java.lang.String getObjectPath(MdObjectStore store,
PrimaryType meta,
boolean includeType)
throws MdException,
java.rmi.RemoteException
Examples of the returned path:
Library (with the type included): "/Shared Data/Libraries/Oracle Library(Library)"
Stored Process (without the type included): "/BIP Tree/Report Studio/Samples/Hello World"
store - the object store to create the objects inpublicObject - the public objectincludeType - If true, the public type will be included in the returned path. Otherwise, the
type will be ignored.
MdException
java.rmi.RemoteException
ResponsibleParty getResponsibleParty(MdObjectStore store,
java.lang.String identityName,
java.lang.String responsibility)
throws MdException,
java.rmi.RemoteException
store - the object store to create the responsible party inidentityName - the name of the user. A value of null will imply
the connected user. If the connected user is PUBLIC, an error will be returned.responsibility - the responsibility to search on (such as Owner or Administrator)
MdException
java.lang.IllegalArgumentException - if responsibility is not provided
java.rmi.RemoteException
ResponsibleParty getResponsibleParty(MdObjectStore store,
java.lang.String identityName,
java.lang.String responsibility,
java.lang.String template,
int flags)
throws MdException,
java.rmi.RemoteException
store - the object store to create the responsible party inidentityName - the name of the user. A value of null will imply
the connected user. If the connected user is PUBLIC, an error will be returned.responsibility - the responsibility to search on (such as Owner or Administrator)template - the template to apply to this responsible party (optional)flags - additional flags to be used when searching for the responsible party
MdException
java.lang.IllegalArgumentException - if responsibility is not provided
java.rmi.RemoteException
int doesObjectExist(java.lang.String reposID,
java.lang.String objectType,
java.lang.String xmlSelect)
throws MdException,
java.rmi.RemoteException
reposID - the repository idobjectType - the metadata object typexmlSelect - an xml select statement to search with
MdException
java.rmi.RemoteException
java.util.List getMetadataObjectsSubset(MdStore inStore,
java.lang.String strReposID,
java.lang.String strType,
int flags,
java.lang.String options)
throws MdException,
java.rmi.RemoteException
inStore - MdStore The store to put the returned objects into.strReposID - String Repository ID.strType - String Type of Metadata object we are wanting to list.flags - int GetMetadataObjects flags.options - String Template or XMLSelect string to selectively get the objects.
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List getMetadataObjectsSubset(MdStore inStore,
java.lang.String strReposID,
java.lang.String strType,
int flags,
java.lang.String options,
boolean doOverrideAssocs)
throws MdException,
java.rmi.RemoteException
inStore - MdStore The store to put the returned objects into.strReposID - String Repository ID.strType - String Type of Metadata object we are wanting to list.flags - int GetMetadataObjects flags.options - String Template or XMLSelect string to selectively get the objects.
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List getMetadataObjectsSubsetList(MdStore inStore,
java.lang.String strReposID,
java.lang.String strType,
int flags,
java.lang.String options,
boolean doOverrideAssocs)
throws MdException,
java.rmi.RemoteException
inStore - MdStore The store to put the returned objects into.strReposID - String Repository ID.strType - String Type of Metadata object we are wanting to list.flags - int GetMetadataObjects flags.options - String Template or XMLSelect string to selectively get the objects.
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List getMetadataObjects(java.lang.String strReposID,
java.lang.String strType,
int iFlags)
throws MdException,
java.rmi.RemoteException
strReposID - Repository ID.strType - Type of Metadata object we are wanting to list.iFlags - int flags for OMI call
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List getMetadataObjects(java.lang.String strReposID,
java.lang.String strType)
throws MdException,
java.rmi.RemoteException
strReposID - Repository ID.strType - Type of Metadata object we are wanting to list.
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List getMetadataObjects(java.lang.String strReposID,
java.lang.String strType,
int flags,
java.lang.String strOptions)
throws MdException,
java.rmi.RemoteException
strReposID - Repository ID.strType - Type of Metadata object we are wanting to list.flags - int GetMetadataObjects flags.strOptions - String Template or XMLSelect string to selectively get the objects.
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List getMetadata(MdStore store,
java.util.Map objectMap,
java.lang.String template,
int flags)
throws MdException,
java.rmi.RemoteException
store - the store to create the objects inobjectMap - a map of the objects to retrieve from the server. Keys for the map must be the
metadata object ids, and the values must be the metadata object types.template - the template you want to apply to these objectsflags - Options to pass in with this call to the server. Valid values are defined as:
MdException
java.rmi.RemoteException
java.util.List getMetadata(MdStore store,
java.util.Map objectMap,
java.lang.String template,
int flags,
boolean doNotOverrideAssocs,
boolean doNotOverrideAttrs)
throws MdException,
java.rmi.RemoteException
store - the store to create the objects inobjectMap - a map of the objects to retrieve from the server. Keys for the map must be the
metadata object ids, and the values must be the metadata object types.template - the template you want to apply to these objectsflags - Options to pass in with this call to the server. Valid values are defined as:
doNotOverrideAssocs - if true, already set associations will not be overriddendoNotOverrideAttrs - if true, already set attributes will not be overridden
MdException
java.rmi.RemoteException
org.w3c.dom.Document getMetadata(java.lang.String inXML,
int iFlags)
throws MdException,
java.rmi.RemoteException
inXML - - Input XML string.iFlags - - OMI server GetMetadata flags.
MdException - in the case of any from server
java.rmi.RemoteException
org.w3c.dom.Document getMetadata(java.lang.String inXML,
java.lang.String strTemplate,
int iFlags)
throws MdException,
java.rmi.RemoteException
inXML - - Input XML string.strTemplate - - Template XML string.iFlags - - OMI server GetMetadata flags.
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List getMetadataObjects(MdStore inStore,
java.lang.String inXML,
java.lang.String strTemplate,
int iFlags)
throws MdException,
java.rmi.RemoteException
inStore - MdStore The store to put created objects into.inXML - String the XML for the objects requested.strTemplate - - Template XML string.iFlags - - OMI server GetMetadata flags.
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List getMetadataObjects(MdStore inStore,
java.lang.String inXML,
java.lang.String strTemplate,
int iFlags,
boolean doNotOverrideAssocs)
throws MdException,
java.rmi.RemoteException
inStore - MdStore The store to put created objects into.inXML - String the XML for the objects requested.strTemplate - - Template XML string.iFlags - - OMI server GetMetadata flags.
MdException - in the case of any server errors
java.rmi.RemoteException
@Deprecated
java.util.Map getMetadataNoCache(java.lang.String strType,
java.lang.String strFQID,
java.lang.String strOptions,
int iFlags)
throws MdException,
java.rmi.RemoteException
getFastMetadata(Map, String, int).
In the case of the attributes, the attribute name will be the key and the attribute value will be the map's value. For the associations, the association name will be the key and the value will be a list of the associated objects. Each item in the list will be a separate map object.
Note: This method will not create complex objects out of the items returned from the server and nothing will be cached in an object store. This method should only be used when the user wishes to have only basic information for an object. The information returned can be restricted by the use of a template.
strType - the type of metadata objectstrFQID - the metadata object idstrOptions - the xml options (including any templates or search statements)iFlags - OMI server GetMetadata flags
MdException
java.rmi.RemoteException
@Deprecated
java.util.List getMetadataNoCache(java.util.Map objectMap,
java.lang.String strOptions,
int iFlags)
throws MdException,
java.rmi.RemoteException
getFastMetadata(Map, String, int).
In the case of the attributes, the attribute name will be the key and the attribute value will be the map's value. For the associations, the association name will be the key and the value will be a list of the associated objects. Each item in the list will be a separate map object.
Note: This method will not create complex objects out of the items returned from the server and nothing will be cached in an object store.
objectMap - a map of id/type values to search for. The maps keys must be an object's metadata id, and the
values must be the metadata object types.strOptions - the xml options (including any templates or search statements)iFlags - OMI server GetMetadata flags
MdException
java.rmi.RemoteException
@Deprecated
java.util.List getMetadataObjectsNoCache(java.lang.String strType,
java.lang.String strReposId,
java.lang.String strOptions,
int iFlags)
throws MdException,
java.rmi.RemoteException
getFastMetadataObjects(String, String, String, int).
In the case of the attributes, the attribute name will be the key and the attribute value will be the map's value. For the associations, the association name will be the key and the value will be a list of the associated objects. Each item in the list will be a separate map object.
Note: This method will not create complex objects out of the items returned from the server and nothing will be cached in an object store. This method should only be used when the user wishes to have only basic information for an object. The information returned can be restricted by the use of a template.
strType - the type of metadata objectstrReposId - the repository idstrOptions - the xml options (including any templates or search statements)iFlags - OMI server GetMetadata flags
MdException
java.rmi.RemoteException
FastMetadata getFastMetadata(java.lang.String metadataType,
java.lang.String fqid,
java.lang.String options,
int flags)
throws MdException,
java.rmi.RemoteException
FastMetadata object. The returned
attributes and associations are controlled by the GetMetadata option and flag parameters.
Note: This method bypasses normal metadata object processing and object stores. The returned object is a static object containing only a copy of the attributes and associations retrieved when this method is called.
metadataType - the type of metadata objectfqid - the metadata object idoptions - GetMetadata options; typically used to specify a templateflags - GetMetadata flags
MdException
java.rmi.RemoteException
java.util.List<FastMetadata> getFastMetadata(java.util.Map<java.lang.String,java.lang.String> objects,
java.lang.String options,
int flags)
throws MdException,
java.rmi.RemoteException
FastMetadata objects. The
returned attributes and associations are controlled by the GetMetadata option and flag parameters.
Note: This method bypasses normal metadata object processing and object stores. The returned object is a static object containing only a copy of the attributes and associations retrieved when this method is called.
objects - collection of objects to be retrieved. The objects are described by a
Map using object fqid as keys and metadata object types as values.options - GetMetadata options; typically used to specify a templateflags - GetMetadata flags
MdException
java.rmi.RemoteException
java.util.List<FastMetadata> getFastMetadataObjects(java.lang.String strType,
java.lang.String strReposId,
java.lang.String strOptions,
int iFlags)
throws MdException,
java.rmi.RemoteException
FastMetadata objects. The returned objects, attributes, and associations are
controlled by the GetMetadataObjects option and flag parameters.
Note: This method bypasses normal metadata object processing and object stores. The returned object is a static object containing only a copy of the attributes and associations retrieved when this method is called.
metadataType - the type of metadata objectreposId - the repository idoptions - GetMetadataObjects options; typically used to specify XMLSelect search criteria
and templatesflags - GetMetadataObjects flags
MdException
java.rmi.RemoteException
org.w3c.dom.Document DoRequest(java.lang.String inXML)
throws MdException,
java.rmi.RemoteException
inXML - String input for DoRequest Call
MdException - in the case of any server errors
java.rmi.RemoteException
org.w3c.dom.Document DoRequest(java.lang.String inXML,
boolean fUpdateIds)
throws MdException,
java.rmi.RemoteException
inXML - String input for DoRequest Call
MdException - in the case of any server errors
java.rmi.RemoteException
void DoRequestNoReturn(java.lang.String inXML,
boolean fUpdateIds)
throws MdException,
java.rmi.RemoteException
inXML - String input for DoRequest Call
MdException - in the case of any server errors
java.rmi.RemoteException
void processDeletedObjects(org.w3c.dom.Document outDoc)
throws java.rmi.RemoteException
outDoc -
java.rmi.RemoteException
void updateObjectId(org.w3c.dom.Document inDoc,
org.w3c.dom.Document outDoc)
throws MdException,
java.rmi.RemoteException
inDoc - org.w3c.dom.DocumentoutDoc - org.w3c.dom.Document
MdException - in the case of any errors from the factory changing the hashkey.
java.rmi.RemoteException
java.lang.String createGetXMLString(java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> simpleAttr,
java.util.List<java.lang.String> complexAttr)
throws java.rmi.RemoteException
strType - - XML is generated for this type of metadata object.strFQID - - Metadata-id, if get is for specific object. May be null or empty.simpleAttr - - List of simple attributes requested. May be null or empty.complexAttr - - List of complex attributes requested. May be null or empty.
java.rmi.RemoteException
java.lang.String createGetXMLString(java.util.Map<java.lang.String,java.lang.String> objectMap)
throws java.rmi.RemoteException
objectMap - a map of the objects to retrieve. Keys for the map must be the metadata object ids
and the values must be the metadata object type.
java.rmi.RemoteException
java.lang.String createObjectAttributeString(java.util.Map<java.lang.String,java.lang.String> attributes)
throws java.rmi.RemoteException
attributes - a map of the object's attributes
java.rmi.RemoteException
java.lang.String createXMLSubString(java.util.List<java.lang.String> attributes,
java.util.List<java.lang.String> values)
throws java.rmi.RemoteException
attributes - - List of Strings containing the names of the attributes to
fetch NOTE: CASE SENSITIVE! USE THE STATIC VARS in m_factoryvalues - - List of String objects containing the attribute values
java.rmi.RemoteException
java.lang.String createRefreshXML(CMetadata meta,
boolean refreshAssocsSetByServerOnly,
boolean refreshAll)
throws java.rmi.RemoteException
meta - the object to refreshrefreshAssocsSetByServerOnly - refresh associations that have been set by the server onlyrefreshAll - refreshes all associations of the object
java.rmi.RemoteException
java.lang.String cleanStringForXML(java.lang.String s)
throws java.rmi.RemoteException
XMLUtil.normalize(String) instead.
cleanStringForXML takes a String and converts "bad" characters, like \n and others, into acceptable xx entities.
s - String
java.rmi.RemoteException
java.lang.String createUpdateXMLSimple(java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> attributes,
java.util.List<java.lang.String> values)
throws java.rmi.RemoteException
strType - - Type of Metadata object we are fetching the data for (WTABLE, WCOLUMN, etc.)
NOTE: CASE SENSITIVE!!!!strFQID - - Unique ID of the metadata object we are updatingattributes - - List of Strings containing the names of the attributes to
fetch NOTE: CASE SENSITIVE! USE THE STATIC VARS in m_factoryvalues - - List of String objects containing the attribute values to be sent to
the server
java.rmi.RemoteException
void updateMetadataSimple(java.lang.String strType,
java.lang.String strFQID,
java.util.List<java.lang.String> attributes,
java.util.List<java.lang.String> values)
throws MdException,
java.rmi.RemoteException
strType - - Type of Metadata object we are fetching the data for (WTABLE, WCOLUMN, etc.)
NOTE: CASE SENSITIVE!!!!strFQID - - Unique ID of the metadata object we are updatingattributes - - List of Strings containing the names of the attributes to
fetch NOTE: CASE SENSITIVE! USE THE STATIC VARS in m_factoryvalues - - List of String objects containing the attribute values to be sent to
the server
MdException - in the case of any server errors
java.rmi.RemoteException
void updateMetadataSimple(java.lang.String inXML)
throws MdException,
java.rmi.RemoteException
MdException
java.rmi.RemoteException
void updateMetadata(java.lang.String inXML)
throws MdException,
java.rmi.RemoteException
MdException
java.rmi.RemoteException
int updateMetadata(java.lang.String inXML,
org.omg.CORBA.StringHolder outXML,
int iFlags)
throws MdException,
java.rmi.RemoteException
inXML - Input XML string that will be wrapped with the update tag and
other session tags. ie. outXML - StringHodler object containing the XML returned from the server.
This may contain new object IDs if new objects were created.iFlags - int Set to zero.
MdException - in the case of any server errors
java.rmi.RemoteException
int addMetadata(java.lang.String inXML,
java.lang.String reposID,
org.omg.CORBA.StringHolder outXML,
int iFlags)
throws MdException,
java.rmi.RemoteException
inXML - Input XML string that will be wrapped with the add tag and
other session tags. ie. reposID - String representation of an ID in the repository to create the object in.
You can pass in any existing object's ID.outXML - StringHodler object containing the XML returned from the server.
This may contain new object IDs if new objects were created.iFlags - int Flags Set to zero.
MdException - in the case of any server errors
java.rmi.RemoteException
void getTypes(java.util.List<java.lang.String> nameList,
java.util.List<java.lang.String> descList)
throws MdException,
java.rmi.RemoteException
nameList - List of string type names being returned.descList - List of string descriptions being returned.
MdException - in the case of any server errors
java.rmi.RemoteException
void getTypeProperties(java.lang.String objectType,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> attributeMap,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> associationMap)
throws MdException,
java.rmi.RemoteException
Usage:
Map> attributeMap = new HashMap >(); Map > associationMap = new HashMap >(); MdOMIUtil.getTypeProperties(MdFactory.COLUMN, attributeMap, associationMap);
connectionHandle - The IOMI interface to use to process methods.objectType - the metadata object typeattributeMap - map of attributes to be returnedassociationMap - map of associations to be returned
MdException
java.rmi.RemoteException
java.util.List<java.lang.String> getSubTypes(java.lang.String objectType,
boolean includeDescendants)
throws MdException,
java.rmi.RemoteException
objectType - the metadata object typeincludeDescendants - if true, thye method eturns all subtypes along
with all of their descendants.
MdException
java.rmi.RemoteException
CMetadata getAssociatedObject(CMetadata object,
java.lang.String strAssociation,
java.lang.String strTemplate)
throws MdException,
java.rmi.RemoteException
object - CMetadatastrAssociation - name to follow and retrieve objects.strTemplate - - the template you want to apply to the associated object,
an empty string can be used is no template is needed.
MdException - in the case of any server errors
java.rmi.RemoteException
CMetadata getAssociatedObject(CMetadata object,
java.lang.String strAssociation,
java.lang.String strTemplate,
boolean doNotOverrideAssocs)
throws MdException,
java.rmi.RemoteException
object - CMetadatastrAssociation - name to follow and retrieve objects.strTemplate - - the template you want to apply to the associated object,
an empty string can be used is no template is needed.
MdException - in the case of any server errors
java.rmi.RemoteException
AssociationList getAssociatedObjects(CMetadata object,
java.lang.String strAssociation,
java.lang.String strTemplate)
throws MdException,
java.rmi.RemoteException
object - CMetadata object used to get assocaitionstrAssociation - name to follow and retrieve objects.strTemplate - - the template you want to apply to the associated objects,
an empty string can be used is no template is needed.
MdException - in the case of any server errors
java.rmi.RemoteException
AssociationList getAssociatedObjects(CMetadata object,
java.lang.String strAssociation,
java.lang.String strTemplate,
boolean doNotOverrideAssocs)
throws MdException,
java.rmi.RemoteException
object - CMetadata object used to get assocaitionstrAssociation - name to follow and retrieve objects.strTemplate - - the template you want to apply to the associated objects,
an empty string can be used is no template is needed.
MdException - in the case of any server errors
java.rmi.RemoteException
java.lang.String getAttribute(java.lang.String strAttribute,
org.w3c.dom.NamedNodeMap childNodeMap)
throws java.rmi.RemoteException
strAttribute - StringchildNodeMap - org.w3c.dom.NamedNodeMap
java.rmi.RemoteException
org.w3c.dom.Document parseXML(java.lang.String strXML)
throws MdException,
java.rmi.RemoteException
strXML - String is the string input to pass to the parser
MdException - in the case of any parsing exceptions
java.rmi.RemoteException
org.w3c.dom.Document parseXML(java.net.URL xmlDocument)
throws MdException,
java.rmi.RemoteException
xmlDocument - URL is the string input to pass to the parser
MdException - in the case of any server errors
java.rmi.RemoteException
org.w3c.dom.Document parseXML(java.net.URL xmlDocument,
java.util.Map<java.lang.String,java.lang.Boolean> features)
throws MdException,
java.rmi.RemoteException
xmlDocument - URL is the string input to pass to the parserfeatures - - map of features to control the validation rules for the input being parsed
MdException - in the case of any server errors
java.rmi.RemoteException
java.lang.String formatXML(java.lang.String original)
throws java.rmi.RemoteException
XMLUtil.formatXML(String) instead.
Format the XML so that we can read it easier.
original - String
java.rmi.RemoteException
java.util.List<java.lang.String> deleteMetadataObject(CMetadata metadataObject,
java.lang.String template)
throws MdException,
java.rmi.RemoteException
metadataObject - the object to deletetemplate - the template to process when deleting the public object
MdException
java.rmi.RemoteException
java.util.List<java.lang.String> deleteMetadataObject(CMetadata inObject)
throws MdException,
java.rmi.RemoteException
inObject - CMetadata
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List<java.lang.String> deleteMetadataObject(java.lang.String objectType,
java.lang.String objectID)
throws MdException,
java.rmi.RemoteException
objectType - the metadata typeobjectID - the metadata object id
MdException
java.rmi.RemoteException
java.util.List<java.lang.String> deleteMetadataObject(java.lang.String objectType,
java.lang.String objectID,
java.lang.String template)
throws MdException,
java.rmi.RemoteException
objectType - the metadata typeobjectID - the metadata object idtemplate - the template to process when deleting the public object
MdException
java.rmi.RemoteException
java.util.List<java.lang.String> deleteMetadataObjects(java.util.List<? extends CMetadata> inObjects)
throws MdException,
java.rmi.RemoteException
inObjects - List
MdException - in the case of any server errors
java.rmi.RemoteException
java.util.List<java.lang.String> deleteMetadataObjects(java.util.Map<java.lang.String,java.lang.String> inObjects)
throws MdException,
java.rmi.RemoteException
inObjects - Map of the items to be deleted. The keys of the map consist of the object ids
and the values are the object types.
MdException - in the case of any server errors
java.rmi.RemoteException
org.w3c.dom.Document ApplyXML(java.lang.String inXML,
java.lang.String reposID)
throws MdException,
java.rmi.RemoteException
inXML - String containing the XML inside of the reposID - ID of the repository to apply this change to
MdException - in the case of any server errors
java.rmi.RemoteException
Identity getIdentity(MdObjectStore store)
throws MdException,
java.rmi.RemoteException
store - Object Store associated with the metadata server for the current user.
MdException
java.rmi.RemoteException
java.lang.String getFoundationReposID()
throws MdException,
java.rmi.RemoteException
MdException
java.rmi.RemoteException
|
| Metadata |
|
| |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||||