Package com.sas.metadata.remote
Interface MdFactory
- All Superinterfaces:
MetadataObjects,Remote
- All Known Implementing Classes:
MdFactoryImpl
The MdFactory interface is used for controlling the creation of metadata objects and object
stores. Each factory will have its own connection to the metadata server (see
MdOMRConnection).-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe string name of the root Metadata client object.static final StringThis is the default value for all get string objects, "get".static final StringThis is the default value for all get string objects, "set".static final StringThis is the default value for all get string objects, "State".static final StringThis is the default value for all string objects, "".static final StringThe string used for Descriptionstatic final StringThe string used for Environmentstatic final StringThe string use for FOLDERstatic final StringThe string used to represent and Idstatic final intThe factory type assocaited with MdFactoryImplstatic final intThe type associated with MdObjectFactorystatic final StringThe string used for the type of metadata objects.static final StringThe string used to represent the Metadata Creation datestatic final StringThe string used to represent the Metadata Modification datestatic final StringThe string used for the Name of an objectstatic final StringThe string used to represent an object reference in XML to/from the serverstatic final intDOM Parsingstatic final intSAX Parsingstatic final StringThe string used for the WarehouseFields inherited from interface com.sas.metadata.remote.MetadataObjects
ABSTRACTEXTENSION, ABSTRACTJOB, ABSTRACTPROMPT, ABSTRACTPROPERTY, ABSTRACTTRANSFORMATION, ACCESSCONTROL, ACCESSCONTROLENTRY, ACCESSCONTROLTEMPLATE, ACTION, AGGREGATION, ANALYTICCOLUMN, ANALYTICCONTEXT, ANALYTICTABLE, APPLICATIONACTION, ARCHIVEENTRY, ARCHIVEFILE, ASSOCIATIONPROPERTY, ATTRIBUTEPROPERTY, AUTHENTICATIONDOMAIN, CALCULATEDMEASURE, CALCULATEDMEMBER, CHANGE, CLASSIFIER, CLASSIFIERMAP, COLUMN, COLUMNHIERARCHY, COLUMNRANGE, COMCONNECTION, CONDITION, CONDITIONACTIONSET, CONDITIONALPRECEDENCE, CONFIGUREDCOMPONENT, CONNECTION, CONTENTLOCATION, CONTENTTYPE, CUBE, CUSTOMASSOCIATION, DATABASECATALOG, DATABASESCHEMA, DATASOURCENAME, DATATABLE, DEPLOYEDCOMPONENT, DEPLOYEDDATAPACKAGE, DEVICE, DEVICETYPE, DIMENSION, DIRECTORY, DOCUMENT, EMAIL, EVENT, EXTENSION, EXTERNALIDENTITY, EXTERNALTABLE, FAVORITESCONTAINER, FEATURE, FEATUREMAP, FILE, FITSTATISTIC, FOREIGNKEY, GLOBALFORMULA, GROUP, GROUPBYCLAUSE, HAVINGCLAUSE, HIERARCHY, HIERARCHYLEVEL, IDENTITY, IDENTITYGROUP, INDEX, INTERNALLOGIN, ITCHANNEL, ITCONTENTSUBSCRIBER, ITEVENTSUBSCRIBER, ITFILTER, ITSUBSCRIBER, JFJOB, JOB, JOIN, JOINTABLE, KEY, KEYASSOCIATION, KEYWORD, LEVEL, LOCALIZEDRESOURCE, LOCALIZEDTYPE, LOCATION, LOGICALCOLUMN, LOGICALSERVER, LOGIN, MACHINE, MEASURE, MEMORY, MININGRESULT, NAMEDSERVICE, NAMEDSET, NUMERICEXTENSION, OLAPPROPERTY, OLAPSCHEMA, OMA_MODEL_DESC, OMA_MODEL_NAME, OMA_MODEL_VERSION, ONCLAUSE, OPENCLIENTCONNECTION, ORDERBYCLAUSE, PERMISSION, PERMISSIONCONDITION, PERSON, PHONE, PHYSICALTABLE, PRIMARYTYPE, PROMPT, PROMPTGROUP, PROPERTY, PROPERTYGROUP, PROPERTYSET, PROPERTYTYPE, PROTOTYPE, PROTOTYPEPROPERTY, PSCOLUMNLAYOUTCOMPONENT, PSLAYOUTCOMPONENT, PSPORTALPAGE, PSPORTALPROFILE, PSPORTLET, QUERYCLAUSE, QUERYTABLE, RELATIONALSCHEMA, RELATIONALTABLE, REPORT, RESPONSIBLEPARTY, ROLE, ROOT, ROWSELECTOR, SASCATALOG, SASCATALOGENTRY, SASCLIENTCONNECTION, SASFILEREF, SASLIBRARY, SASLICENSE, SASPASSWORD, SEARCH, SECONDARYTYPE, SECUREDLIBRARY, SECUREDTABLE, SECURITYRULE, SECURITYRULESCHEME, SECURITYTYPECONTAINMENTRULE, SELECT, SERVERCOMPONENT, SERVERCONTEXT, SERVICECOMPONENT, SERVICETYPE, SHAREDDIMENSION, SOFTWARECOMPONENT, STEPPRECEDENCE, STREAM, SXLEMAP, SYNCSTEP, TABLECOLLECTION, TARGET, TCPIPCONNECTION, TESTCAT, TESTFLEA, TESTGRANDKITTEN, TESTKITTEN, TESTLEG, TESTMOUSE, TESTREQATTRS, TESTROOT, TEXT, TEXTSTORE, TIMESTAMP, TRANSFORMATION, TRANSFORMATIONACTIVITY, TRANSFORMATIONSTEP, TREE, TSNAMEOBJECT, TSNAMESPACE, TYPEDEFINITION, UNIQUEKEY, UNITOFTIME, VARIABLE, WHERECLAUSE, WORKTABLE, XPATH -
Method Summary
Modifier and TypeMethodDescriptionvoidaddMdFactoryListener(MdFactoryListener listener) Registers a factory listenervoidaddMdFactoryListener(MdFactoryListener listener, String[] objectTypes) Registers a factory listener.voidDeprecated.voidUsed to add an object to the list of listeners for changes in the Metadata MapvoidchangeHashKey(String strOldId, String strNewId) Change the hash key associated with an object, and notify listenersvoidchangeImplementationExtension(String newExtension) This sets the extension for files in the implementation.voidchangeImplementationPackage(String newPackage) This changes the java package implementation files are loaded from.voidDeprecated.this method has been renamed tocloseOMRConnection()voidClose connection to OMRcreateComplexMetadataObject(MdObjectStore oStore, CMetadata oSimple) Creates a complex/detailed metadata object in a given object store.createComplexMetadataObject(MdObjectStore inStore, MdStore parentStore, CMetadata oSimple) Create a complex/detailed metadata object given the name,type, and ID of that object.createComplexMetadataObject(MdObjectStore inStore, MdStore parentStore, String strName, String strType, String strFQID) Create a complex/detailed metadata object given the name,type, and ID of that object.createComplexMetadataObject(MdObjectStore inStore, MdStore parentStore, String strName, String strType, String strFQID, String strNewObjectExternalIdentityRealRepos) Create a complex/detailed metadata object given the name,type, and ID of that object.createComplexMetadataObject(MdObjectStore oStore, String strName, String strType, String strFQID) Creates a complex/detailed metadata object in a given object store.createComplexMetadataObject(MdStore inStore, MdStore parentStore, String strName, String strType, String strFQID, String strNewObjectExternalIdentityRealRepos) Deprecated.Objects should only be created in an ObjectStore.createComplexMetadataObjectServerStoreOnly(String strName, String strType, String strFQID) Deprecated.As of 9.2, complex objects should no longer be created within the ServerStore.createComplexMetadataObjectStoreOnly(MdStore inStore, String strName, String strType, String strFQID) Create a complex/detailed object in specified store only.Returns a MdObjectStore for use in storing objects, and creating objects.createObjectStore(MdStore parentStore) Returns a MdObjectStore for use in storing objects, and creating objects.createObjectStore(MdStore parentStore, String storeName) Returns a MdObjectStore for use in storing objects, and creating objects.createSimpleMetadataObject(CMetadata inObject) Creates an object to be used as a place holder for a more complex object.createSimpleMetadataObject(CMetadata inObject, String lockedBy) Creates an object to be used as a place holder for a more complex object.createSimpleMetadataObject(String strName, String strType, String strFQID) Creates an object to be used as a place holder for a more complex object.createSimpleMetadataObject(String strName, String strType, String strFQID, String lockedBy) Creates an object to be used as a place holder for a more complex object.voiddeleteDetailMetadataObject(String strFQID) Deletes an object from the detail Map and fires the MetadataRemoved event.voiddeleteMetadataObject(CMetadata delobject) Removes the object from the client and from the server if the object exists on the server.voiddeleteMetadataObjects(CMetadata deleteObject, String template) Removes the object from the detail Map and from the server!voiddeleteMetadataObjects(String objectName, String objectType, String objectFQID, String template) Removes the object from the detail Map and from the server!voiddeleteMetadataObjects(List<? extends CMetadata> objectList) Removes the object from the detail Map and from the server!voiddeleteObjectsFromStores(List<String> objectList) Deprecated.voiddeleteObjectsFromStores(Map<String, String> objectMap) Removes a list of objects from all object stores.voiddeletePublicObject(CMetadata publicObject) Deletes a public object from the server.voiddeletePublicObject(CMetadata publicObject, String template) Deletes a public object from the server.voiddispose()Removes all objects and references so this object can be garbage collected.voidPrints out the contents of the Detail object Map.voidfireMdObjectCreated(MdEvent e, String id) Deprecated.voidfireMdObjectDeleted(MdEvent e, String id) Deprecated.voidfireMdObjectsCreated(MdEvent e, List<String> id) Deprecated.voidUsed to notify all the Factory listeners of new objects created on the server.voidUsed to notify all the Factory listeners of objects deleted from the server.voidUsed to notify all the Factory listeners of objects modified on the server.Return resource bundle used to access localized resourcesbooleanGets the status of change management enable/disabled.Returns the connection object.booleangetDebug()Gets whether debug information is on for this instance of SAS Java Metadata Interface.Map<String, CMetadata> Deprecated.As of 9.2, complex objects should no longer be stored in the ServerStoreGet's the instance of the factory.booleanGets whether XML transaction logging information is on for this instance of SAS Java Metadata Interface.intThis can return MDFACTORYTYPE_MDOBJECTFACTORY or MDFACTORYTYPE_MDFACTORYIMPLgetObject(String strFQID) Deprecated.As of 9.2, complex objects are no longer stored in the ServerStore.Get's the OMI Utility classintGet the type of parser currently being used, SAX or DOMbooleangetPerf()Tells whether or not to output performance messagesbooleanReturns whether or not dependent objects should be removed when an object is removed from its object store.Returns the MdRepositoryUtil interface used for utility methods for metadata repositories.Returns the MdSecurityUtil instance used for security related operations.Map<String, CMetadata> Returns the Simple Object MapgetStore()Deprecated.As of 9.2, the ServerStore should no longer be used.booleanReturns whether the date attributes (MetadataCreated and MetadataUpdated) on an object should be formatted by the server or not.MdUtilgetUtil()Returns the MdUtil class used for output.booleanIndicates whether or not the client is running in a true remote environment.voidmakeConnection(String protocol, String host, String port, String username, String password) Deprecated.This method is no longer supported.voidmakeConnection2(String host, String port, String username, String password) Deprecated.this method has been renamed tomakeOMRConnection(String, String, String, String)StringmakeID(String shortID) Creates an ID for a new or temporary object.voidmakeOMRConnection(String host, String port, String username, String password) This makes a connection to OMR using makeOMRConnection in MdOMRConnectionvoidRemoves a listener from the listvoidDeprecated.voidUsed to remove an object from the list of listeners for changes in the Metadata MapvoidremoveStore(MdStore childStore) Remove an object store from the factory for use.voidsetChangeManagementEnabled(boolean enabled) Sets the status of change managementvoidsetDebug(boolean instate) Sets whether debug information is on for this instance of SAS Java Metadata Interface.voidsetLoggingEnabled(boolean instate) Sets whether XML transaction logging information is on for this instance of SAS Java Metadata Interface.voidsetParsingType(int parsing) Sets the type of xml parser to use.voidsetPerf(boolean instate) Tells whether or not to output performance messagesvoidsetRemoveDependentObjects(boolean remove) Sets whether or not dependent objects should be removed when an object is removed from its object store.voidsetUseServerFormattedDates(boolean format) Sets whether the date attributes (MetadataCreated and MetadataUpdated) on an object should be formatted by the server or not.
-
Field Details
-
PARSING_TYPE_SAX
static final int PARSING_TYPE_SAXSAX Parsing- See Also:
-
PARSING_TYPE_DOM
static final int PARSING_TYPE_DOMDOM Parsing- See Also:
-
DESC
static final String DESCThe string used for Description- See Also:
-
ENVIRONMENT
static final String ENVIRONMENTThe string used for Environment- See Also:
-
FOLDER
static final String FOLDERThe string use for FOLDER- See Also:
-
ID
static final String IDThe string used to represent and Id- See Also:
-
METADATACREATED
static final String METADATACREATEDThe string used to represent the Metadata Creation date- See Also:
-
METADATAUPDATED
static final String METADATAUPDATEDThe string used to represent the Metadata Modification date- See Also:
-
NAME
static final String NAMEThe string used for the Name of an object- See Also:
-
WAREHOUSE
static final String WAREHOUSEThe string used for the Warehouse- See Also:
-
OBJREF
static final String OBJREFThe string used to represent an object reference in XML to/from the server- See Also:
-
CMETADATA
static final String CMETADATAThe string name of the root Metadata client object.- See Also:
-
METADATA_TYPE
static final String METADATA_TYPEThe string used for the type of metadata objects.- See Also:
-
DEFAULT_STRING_VALUE
static final String DEFAULT_STRING_VALUEThis is the default value for all string objects, "".- See Also:
-
DEFAULT_GET_STRING_VALUE
static final String DEFAULT_GET_STRING_VALUEThis is the default value for all get string objects, "get".- See Also:
-
DEFAULT_SET_STRING_VALUE
static final String DEFAULT_SET_STRING_VALUEThis is the default value for all get string objects, "set".- See Also:
-
DEFAULT_STATE_STRING_VALUE
static final String DEFAULT_STATE_STRING_VALUEThis is the default value for all get string objects, "State".- See Also:
-
MDFACTORYTYPE_MDOBJECTFACTORY
static final int MDFACTORYTYPE_MDOBJECTFACTORYThe type associated with MdObjectFactory- See Also:
-
MDFACTORYTYPE_MDFACTORYIMPL
static final int MDFACTORYTYPE_MDFACTORYIMPLThe factory type assocaited with MdFactoryImpl- See Also:
-
-
Method Details
-
isRemoteEnvironment
boolean isRemoteEnvironment() throws RemoteExceptionIndicates whether or not the client is running in a true remote environment.- Returns:
- true if in a remote environment, false otherwise
- Throws:
RemoteException
-
makeConnection
void makeConnection(String protocol, String host, String port, String username, String password) throws MdException, RemoteException Deprecated.This method is no longer supported. UsemakeOMRConnection(String, String, String, String)instead.This makes a connection to OMR using makeOMRConnection in MdOMRConnection- Parameters:
protocol- IGNOREDhost- Host name to connect toport- Port on host to connect tousername- user's name on hostpassword- password for username- Throws:
MdExceptionRemoteException
-
makeConnection2
void makeConnection2(String host, String port, String username, String password) throws MdException, RemoteException Deprecated.this method has been renamed tomakeOMRConnection(String, String, String, String)This makes a connection to OMR using makeOMRConnection in MdOMRConnection- Parameters:
host- Host name to connect toport- Port on host to connect tousername- user's name on hostpassword- password for username- Throws:
MdExceptionRemoteException
-
closeConnection
void closeConnection() throws RemoteExceptionDeprecated.this method has been renamed tocloseOMRConnection()Close connection to OMI- Throws:
RemoteException
-
makeOMRConnection
void makeOMRConnection(String host, String port, String username, String password) throws MdException, RemoteException This makes a connection to OMR using makeOMRConnection in MdOMRConnection- Parameters:
host- Host name to connect toport- Port on host to connect tousername- user's name on hostpassword- password for username- Throws:
MdExceptionRemoteException
-
closeOMRConnection
void closeOMRConnection() throws RemoteExceptionClose connection to OMR- Throws:
RemoteException
-
getMdFactoryType
int getMdFactoryType() throws RemoteExceptionThis can return MDFACTORYTYPE_MDOBJECTFACTORY or MDFACTORYTYPE_MDFACTORYIMPL- Returns:
- the type of factory this is.
- Throws:
RemoteException
-
getDebug
boolean getDebug() throws RemoteExceptionGets whether debug information is on for this instance of SAS Java Metadata Interface.- Throws:
RemoteException
-
setDebug
void setDebug(boolean instate) throws RemoteException Sets whether debug information is on for this instance of SAS Java Metadata Interface.- Throws:
RemoteException
-
getLoggingEnabled
boolean getLoggingEnabled() throws RemoteExceptionGets whether XML transaction logging information is on for this instance of SAS Java Metadata Interface.- Throws:
RemoteException
-
getPerf
boolean getPerf() throws RemoteExceptionTells whether or not to output performance messages- Throws:
RemoteException
-
setPerf
void setPerf(boolean instate) throws RemoteException Tells whether or not to output performance messages- Throws:
RemoteException
-
setLoggingEnabled
void setLoggingEnabled(boolean instate) throws RemoteException Sets whether XML transaction logging information is on for this instance of SAS Java Metadata Interface.- Throws:
RemoteException
-
getUtil
MdUtil getUtil() throws RemoteExceptionReturns the MdUtil class used for output.- Returns:
- MdUtil class.
- Throws:
RemoteException
-
getRepositoryUtil
Returns the MdRepositoryUtil interface used for utility methods for metadata repositories.- Returns:
- the MdRepositoryUtil interface
- Throws:
RemoteException
-
getSecurityUtil
Returns the MdSecurityUtil instance used for security related operations.- Returns:
- the MdSecurityUtil instance
- Throws:
RemoteException
-
getInstance
Get's the instance of the factory.(this)- Returns:
- MdObjectFactory this instance.
- Throws:
RemoteException
-
getParsingType
int getParsingType() throws RemoteExceptionGet the type of parser currently being used, SAX or DOM- Returns:
- the parsing type
- Throws:
RemoteException
-
setParsingType
void setParsingType(int parsing) throws RemoteException Sets the type of xml parser to use. Valid options areMdFactory.PARSING_TYPE_SAXorMdFactory.PARSING_TYPE_DOM- Parameters:
parsing-- Throws:
RemoteException
-
getOMIUtil
Get's the OMI Utility class- Returns:
- MdOMIUtil class
- Throws:
RemoteException
-
getConnection
Returns the connection object.- Returns:
- MdOMRConnection the interface of the connection object
- Throws:
RemoteException
-
getChangeManagementEnabled
boolean getChangeManagementEnabled() throws RemoteExceptionGets the status of change management enable/disabled.- Throws:
RemoteException
-
setChangeManagementEnabled
void setChangeManagementEnabled(boolean enabled) throws RemoteException Sets the status of change management- Throws:
RemoteException
-
setRemoveDependentObjects
void setRemoveDependentObjects(boolean remove) throws RemoteException Sets whether or not dependent objects should be removed when an object is removed from its object store.- Parameters:
remove- true if removing dependent objects- Throws:
RemoteException
-
getRemoveDependentObjects
boolean getRemoveDependentObjects() throws RemoteExceptionReturns whether or not dependent objects should be removed when an object is removed from its object store. Default value is false.- Returns:
- true if removing dependent objects
- Throws:
RemoteException
-
setUseServerFormattedDates
void setUseServerFormattedDates(boolean format) throws RemoteException Sets whether the date attributes (MetadataCreated and MetadataUpdated) on an object should be formatted by the server or not. The default is set totrue.- Parameters:
format- true if dates should be formatted- Throws:
RemoteException
-
getUseServerFormattedDates
boolean getUseServerFormattedDates() throws RemoteExceptionReturns whether the date attributes (MetadataCreated and MetadataUpdated) on an object should be formatted by the server or not. The default value istruemeaning the server will apply its own formatting to the dates.- Returns:
- true if dates are being formatted
- Throws:
RemoteException
-
getSimpleObjectMap
Returns the Simple Object Map- Returns:
- The association Map
- Throws:
RemoteException
-
getDetailObjectMap
Deprecated.As of 9.2, complex objects should no longer be stored in the ServerStoreReturns the Detail Object Map- Returns:
- The association Map
- Throws:
RemoteException
-
getStore
Deprecated.As of 9.2, the ServerStore should no longer be used. All objects should be created in an ObjectStore instead.Returns the Server store this factory uses to create objects- Returns:
- MdServerStore
- Throws:
RemoteException
-
createObjectStore
Returns a MdObjectStore for use in storing objects, and creating objects.- Returns:
- a new MdObjectStore object.
- Throws:
RemoteException
-
createObjectStore
Returns a MdObjectStore for use in storing objects, and creating objects.- Parameters:
parentStore- MdStore the store that owns this one, i.e. its parent.- Returns:
- a new MdObjectStore object,
- Throws:
RemoteException
-
createObjectStore
Returns a MdObjectStore for use in storing objects, and creating objects.- Parameters:
parentStore- MdStore the store that owns this one, i.e. its parent.- Returns:
- a new MdObjectStore object,
- Throws:
RemoteException
-
createSimpleMetadataObject
Creates an object to be used as a place holder for a more complex object. These objects usually only have name,type, and ID populated. A simple object does not have any associations.- Parameters:
inObject- CMetadata object- Returns:
- CMetadata object with passed in attributes populated.
- Throws:
RemoteException
-
createSimpleMetadataObject
Creates an object to be used as a place holder for a more complex object. These objects usually only have name,type, and ID populated. A simple object does not have any associations.- Parameters:
inObject- CMetadata Object to get name, type, and ID from.lockedBy- String Which object has this one locked.- Returns:
- CMetadata object with passed in attributes populated.
- Throws:
RemoteException
-
createSimpleMetadataObject
CMetadata createSimpleMetadataObject(String strName, String strType, String strFQID, String lockedBy) throws RemoteException Creates an object to be used as a place holder for a more complex object. These objects usually only have name,type, and ID populated. A simple object does not have any associations.- Parameters:
strName- StringstrType- StringstrFQID- String (NOTE: If the ID is repository only, a new object is created)lockedBy- String The object that has this one locked in change management.- Returns:
- CMetadata object with passed in attributes populated.
- Throws:
RemoteException
-
createSimpleMetadataObject
CMetadata createSimpleMetadataObject(String strName, String strType, String strFQID) throws RemoteException Creates an object to be used as a place holder for a more complex object. These objects usually only have name,type, and ID populated. A simple object does not have any associations.- Parameters:
strName- StringstrType- StringstrFQID- String (NOTE: If the ID is repository only, a new object is created)- Returns:
- CMetadata object with passed in attributes populated.
- Throws:
RemoteException
-
createComplexMetadataObject
CMetadata createComplexMetadataObject(MdObjectStore oStore, CMetadata oSimple) throws RemoteException Creates a complex/detailed metadata object in a given object store.- Parameters:
oStore- MdObjectStoreoSimple- CMetadata- Returns:
- the CMetadata object or a null can be returned if the object has an invalid metadata type and couldn't be created
- Throws:
RemoteException
-
createComplexMetadataObject
CMetadata createComplexMetadataObject(MdObjectStore inStore, MdStore parentStore, CMetadata oSimple) throws RemoteException Create a complex/detailed metadata object given the name,type, and ID of that object.- Parameters:
inStore- MdObjectStore Store to copy object into upon creation.parentStore- MdStore Store that owns any newly created store.oSimple- CMetadata object to use to create the new object- Returns:
- the CMetadata object or a null can be returned if the object has an invalid metadata type and couldn't be created
- Throws:
RemoteException
-
createComplexMetadataObject
CMetadata createComplexMetadataObject(MdObjectStore inStore, MdStore parentStore, String strName, String strType, String strFQID) throws RemoteException Create a complex/detailed metadata object given the name,type, and ID of that object. Creates the object ininStoreand sets the owningstore for the new store ifinStoreis null and a new store is created for the object.- Parameters:
inStore- Store to copy object into upon creation.parentStore- Store that owns any newly created store.strName- the object namestrType- the metadata object typestrFQID- the metadata object id. A new id will be assigned to the object if strFQID passed in is the 8 character repository id (ie. "A57BBBVO").- Returns:
- the CMetadata object or a null can be returned if the object has an invalid metadata type and couldn't be created
- Throws:
RemoteException
-
createComplexMetadataObject
CMetadata createComplexMetadataObject(MdObjectStore oStore, String strName, String strType, String strFQID) throws RemoteException Creates a complex/detailed metadata object in a given object store.- Parameters:
oStore- MdObjectStorestrName- the object namestrType- the metadata object typestrFQID- the metadata object id. A new id will be assigned to the object if strFQID passed in is the 8 character repository id (ie. "A57BBBVO").- Returns:
- the CMetadata object or a null can be returned if the object has an invalid metadata type and couldn't be created
- Throws:
RemoteException
-
createComplexMetadataObject
CMetadata createComplexMetadataObject(MdStore inStore, MdStore parentStore, String strName, String strType, String strFQID, String strNewObjectExternalIdentityRealRepos) throws RemoteException Deprecated.Objects should only be created in an ObjectStore. Deprecated as of 9.2. UsecreateComplexMetadataObject(MdObjectStore, MdStore, String, String, String, String)instead.Create a complex/detailed metadata object given the name,type, and ID of that object. Creates the object ininStoreand sets the owningstore for the new store ifinStoreis null and a new store is created for the object.- Parameters:
inStore- Store to copy object into upon creation.parentStore- Store that owns any newly created store.strName- the object namestrType- the metadata object typestrFQID- the metadata object id. A new id will be assigned to the object if strFQID passed in is the 8 character repository id (ie. "A57BBBVO").strNewObjectExternalIdentityRealRepos- The Repos the object will reside in if under change management.- Returns:
- the CMetadata object or a null can be returned if the object has an invalid metadata type and couldn't be created
- Throws:
RemoteException
-
createComplexMetadataObject
CMetadata createComplexMetadataObject(MdObjectStore inStore, MdStore parentStore, String strName, String strType, String strFQID, String strNewObjectExternalIdentityRealRepos) throws RemoteException Create a complex/detailed metadata object given the name,type, and ID of that object. Creates the object ininStoreand sets the owningstore for the new store ifinStoreis null and a new store is created for the object.- Parameters:
inStore- Store to copy object into upon creation.parentStore- Store that owns any newly created store.strName- the object namestrType- the metadata object typestrFQID- the metadata object id. A new id will be assigned to the object if strFQID passed in is the 8 character repository id (ie. "A57BBBVO").strNewObjectExternalIdentityRealRepos- The Repos the object will reside in if under change management.- Returns:
- the CMetadata object or a null can be returned if the object has an invalid metadata type and couldn't be created
- Throws:
RemoteException
-
createComplexMetadataObjectServerStoreOnly
CMetadata createComplexMetadataObjectServerStoreOnly(String strName, String strType, String strFQID) throws RemoteException Deprecated.As of 9.2, complex objects should no longer be created within the ServerStore.Create a complex/detailed object in this server store only.- Parameters:
strName- StringstrType- StringstrFQID- String- Throws:
RemoteException
-
createComplexMetadataObjectStoreOnly
CMetadata createComplexMetadataObjectStoreOnly(MdStore inStore, String strName, String strType, String strFQID) throws RemoteException Create a complex/detailed object in specified store only.- Parameters:
inStore- MdStore Place to create object.strName- StringstrType- StringstrFQID- String- Throws:
RemoteException
-
deleteDetailMetadataObject
void deleteDetailMetadataObject(String strFQID) throws RemoteException Deletes an object from the detail Map and fires the MetadataRemoved event.- Parameters:
strFQID- String- Throws:
RemoteException
-
deletePublicObject
Deletes a public object from the server. As long as the object specified has thePublicTypeattribute populated, the metadata server will handle deleting the entire public object using the template stored in the TypeDictionary. If the object does not have a corresponding entry in the TypeDictionary, only the top level object will be deleted.- Parameters:
publicObject- the public object to delete- Throws:
MdExceptionRemoteException
-
deletePublicObject
void deletePublicObject(CMetadata publicObject, String template) throws MdException, RemoteException Deletes a public object from the server. This method can be used to override any delete template stored in the TypeDictionary.- Parameters:
publicObject- the public object to deletetemplate- the delete template. The template must be in the following format:<Template TemplateName="PUBLIC_TYPE"> <METADATA_TYPE> <!-- additional associations and objects belong here --> </METADATA_TYPE> </Template>Where METADATA_TYPE is the metadata type of thepublicObjectand PUBLIC_TYPE is the type name as defined in the TypeDictionary- Throws:
MdExceptionRemoteException
-
deleteMetadataObject
Removes the object from the client and from the server if the object exists on the server. This should be used to remove an object completely from the server and client.This method should be used to delete any public object. As long as the CMetadata object specified has the PublicType attribute populated, the metadata server will handle deleting the entire public object.
- Parameters:
delobject- the CMetadata object to delete- Throws:
MdExceptionRemoteException
-
deleteMetadataObjects
void deleteMetadataObjects(CMetadata deleteObject, String template) throws MdException, RemoteException Removes the object from the detail Map and from the server!- Parameters:
deleteObject- CMetadatatemplate- String- Throws:
MdExceptionRemoteException
-
deleteMetadataObjects
void deleteMetadataObjects(String objectName, String objectType, String objectFQID, String template) throws MdException, RemoteException Removes the object from the detail Map and from the server! Using the template provided.- Parameters:
objectName- StringobjectType- StringobjectFQID- Stringtemplate- String- Throws:
MdExceptionRemoteException
-
deleteMetadataObjects
void deleteMetadataObjects(List<? extends CMetadata> objectList) throws MdException, RemoteException Removes the object from the detail Map and from the server! Remember the delete will fail if the object and its dependent objects are both in this list. For example if a Table and a Column are in this list and the table owns the column then the column should not be in the list, because it will automatically be deleted from the server when the table is deleted, because of its "table" association cardinality 1 to 1.- Parameters:
objectList- a list of CMetadata objects to delete from the server.- Throws:
MdExceptionRemoteException
-
deleteObjectsFromStores
void deleteObjectsFromStores(List<String> objectList) throws RemoteException Deprecated.Removes a list of objects from all object stores. This method assumes that these objects have already been removed from th server.- Parameters:
objectList- list of object ids to delete from the client- Throws:
RemoteException
-
deleteObjectsFromStores
void deleteObjectsFromStores(Map<String, String> objectMap) throws RemoteExceptionRemoves a list of objects from all object stores. This method assumes that these objects have already been removed from th server.- Parameters:
objectMap- a map of all object ids and types to delete from the client.- Throws:
RemoteException
-
makeID
String makeID(String shortID) throws RemoteException Creates an ID for a new or temporary object.- Parameters:
shortID- String- Throws:
RemoteException
-
dumpDetailHashMap
void dumpDetailHashMap() throws RemoteExceptionPrints out the contents of the Detail object Map.- Throws:
RemoteException
-
dispose
void dispose() throws RemoteExceptionRemoves all objects and references so this object can be garbage collected.- Throws:
RemoteException
-
getBundle
Return resource bundle used to access localized resources- Throws:
RemoteException
-
getObject
Deprecated.As of 9.2, complex objects are no longer stored in the ServerStore. Objects should be created in an ObjectStore.Return object associated with ID- Parameters:
strFQID-- Returns:
- CMetadata Object with that id, or null if object not in Detail Map.
- Throws:
RemoteException
-
changeHashKey
void changeHashKey(String strOldId, String strNewId) throws RemoteException Change the hash key associated with an object, and notify listeners- Parameters:
strOldId- StringstrNewId- String- Throws:
RemoteException
-
changeImplementationPackage
void changeImplementationPackage(String newPackage) throws RemoteException This changes the java package implementation files are loaded from.- Parameters:
newPackage- String The name of the java package to load implementation files from.- Throws:
RemoteException
-
changeImplementationExtension
void changeImplementationExtension(String newExtension) throws RemoteException This sets the extension for files in the implementation.- Parameters:
newExtension- String The name to append to name of model files.- Throws:
RemoteException
-
removeStore
Remove an object store from the factory for use. Also removes any objects that are not being used by any other ObjectStore.- Parameters:
childStore- MdStore The store to remove.- Throws:
RemoteException
-
addMdObjectListener
Used to add an object to the list of listeners for changes in the Metadata Map- Parameters:
l- MetadataListener- Throws:
RemoteException
-
removeMdObjectListener
Used to remove an object from the list of listeners for changes in the Metadata Map- Parameters:
l- MetadataListener- Throws:
RemoteException
-
addMdObjectFactoryListener
Deprecated.Used to add an object to the list of listeners for changes in the Metadata Map- Parameters:
l- MetadataListener- Throws:
RemoteException
-
removeMdObjectFactoryListener
Deprecated.Used to remove an object from the list of listeners for changes in the Metadata Map- Parameters:
l- MetadataListener- Throws:
RemoteException
-
addMdFactoryListener
Registers a factory listener- Parameters:
listener- the listener to register- Throws:
RemoteException
-
addMdFactoryListener
Registers a factory listener. This method allows clients to filter the set events that are fired by the factory. Events will only be fired when the object map, seeMdFactoryEvent.getObjectMap(), contains objects of the specified types.For instance, if a client chooses to only be notified when modifications are made to either PhysicalTables or Libraries, they can specify this via the
objectTypesparameter. In this case, the client can call:MdFactory factory; MdFactoryListener listener; String interestedTypes[] = new String[] {MetadataObjects.PHYSICALTABLE, MetadataObjects.SASLIBRARY}; factory.addMdFactoryListener(listener, interestedTypes);Any time a created, deleted, or modified event is fired, the objects contained in the event's map will only be of the specified types. All other types will be filtered out of the map.Note: If the event's object map does not contain any tables or libraries, the listener will never be notified.
- Parameters:
listener- the listener to registerobjectTypes- an array of metadata types used to filter when events are fired. Events will only be fired by the factory if the object(s) contained in the event are of the specified type.- Throws:
RemoteException
-
removeMdFactoryListener
Removes a listener from the list- Parameters:
l- MdFactoryListener- Throws:
RemoteException
-
fireMdObjectCreated
Deprecated.Used to notify all the Factory listeners of newly created objects.- Parameters:
e- ChangeEvent Created like:new ChangeEvent(Object generator)id- FQID of newly created object- Throws:
RemoteException
-
fireMdObjectsCreated
Deprecated.Used to notify all the Factory listeners of newly created objects.- Parameters:
e- ChangeEvent Created like:new ChangeEvent(Object generator)id- FQID of newly created object- Throws:
RemoteException
-
fireMdObjectDeleted
Deprecated.Used to notify all the Factory listeners of deleted objects.- Parameters:
e- MdEvent Created like:new ChangeEvent(Object generator, obj.getFQID)id- FQID of newly created object- Throws:
RemoteException
-
fireMdObjectsCreated
Used to notify all the Factory listeners of new objects created on the server.- Parameters:
e- MdFactoryEvent- Throws:
RemoteException
-
fireMdObjectsModified
Used to notify all the Factory listeners of objects modified on the server.- Parameters:
e- MdFactoryEvent- Throws:
RemoteException
-
fireMdObjectsDeleted
Used to notify all the Factory listeners of objects deleted from the server.- Parameters:
e- MdFactoryEvent- Throws:
RemoteException
-
addMdFactoryListener(MdFactoryListener)