com.sas.metadata.remote
Interface MdObjectStore

All Superinterfaces:

java.util.EventListener, MdObjectListener, MdStore, MdStoreListener, MetadataObjects, java.rmi.Remote

public interface MdObjectStore
extends MdStore, MetadataObjects, MdObjectListener, MdStoreListener, java.rmi.Remote

This a store of objects for a view's interaction. This is the views object cache, and allows for the modification of objects without effects on other views. The changes in objects are persisted to the store that owns this one upon a write to the server.

Field Summary

Fields inherited from interface com.sas.metadata.remote.MdStore

ExternalIdenty_Context, ExternalIdenty_ImportType, MDSTORETYPE_OBJECTSTORE, MDSTORETYPE_SERVERSTORE

Fields 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, 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, 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

void	addElementToChangeList(CMetadata object) Adds the specified metadata object to this object's change list; only adds the object if it is not already in the list
void	addMdObjectListener(MdObjectListener l) Used to add an object to the list of listeners for changes in the Metadata Map
void	addMdStoreIDChangeListener(MdStoreIDChangeListener l) Used to add an object to the list of listeners for changes in the Metadata Map
void	addMdStoreListener(MdStoreListener l) Used to add an object to the list of listeners for changes in the Metadata Map
void	addObjToAuthorizationTransContextList(CMetadata obj) Add an object to the Authorization Transaction Context List for this Store
void	addVetoableChangeListener(java.beans.VetoableChangeListener l) Adds a listener to the list
void	appendWriteBuffer(java.lang.String appendText) Append the text to the write buffer for this store.
void	changeHashKey(java.lang.String strOldId, java.lang.String strNewId) Change the hash key associated with an object, and send events for the removal of the old object and addition of the new object to Map.
void	clearAuthorizationTransContextList() Clear the Authorization Transaction Context List for this Store
void	clearChangeList() Remove all elements from the change list, and set it to empty
void	clearObjectsFromStore()
void	clearWriteBuffer() Clear write append buffer out
void	createExternalIdentityObject(CMetadata owningObject) Deprecated. As of 9.2 this method is no longer supported
java.lang.String	createRefreshXMLforStore(boolean includeLocallyChangedItems, boolean getFullObjectUpdate) Creates XML for all objects in store.
java.lang.String	createXMLforStore() Creates XML for all objects in store.
void	deleteDetailMetadataObject(java.lang.String strFQID) Deletes an object from the detail Map and fires the MetadataRemoved event.
boolean	deleteObject(CMetadata inObject) Makes an object unavailable in the object store.
void	deleteObjectFromStore(java.lang.String strFQID) Delete the object from this store and all object stores.
void	dispose() Cleans up this objectStore and it's objects from it's parent.
void	dumpDetailHashMap() Prints out the contents of this MdObjectStore.
void	flushUpdates(java.util.List<CMetadata> updatedItems) Flush updated objects to parent store.
java.util.Vector<CMetadata>	getAuthorizationTransContextList()
java.util.List<CMetadata>	getChangedObjects() Gets a List of changed objects.
java.util.Vector<CMetadata>	getChangeList() Return the current change list
java.util.List<java.lang.String>	getCreatedItemsList() Returns the list of items created in current write.
java.util.Map<java.lang.String,CMetadata>	getDeletedObjects() Return a Map of the objects being deleted.
java.util.Map<java.lang.String,CMetadata>	getDetailObjectMap() Returns the Detail Object Map
MdFactory	getFactory() Returns the factory used to create objects.
java.lang.String	getIdentifier() Returns an identifier for this object store.
boolean	getIsGoToServerForMetadata() Deprecated. isGoToServerForMetadata() should be used instead
boolean	getIsObjectCopiedFromParentOnCreation() Gets whether new objects in this store are copied fromt their parent on creation if the object exists in their parent store.
java.lang.String	getNewObjectRepositoryID() Deprecated. As of 9.2 this method is no longer supported
java.util.List<CMetadata>	getNewObjects() Gets a List of changed objects.
CMetadata	getObject(java.lang.String strFQID) Return object associated with ID
CMetadata	getObject(java.lang.String strFQID, boolean hashonly) Return object associated with ID
MdStore	getOwningStore() Gets the parent store to this one
java.lang.String	getProjectRepositoryID() Deprecated. As of 9.2 this method is no longer supported
java.util.Map<java.lang.String,CMetadata>	getSimpleObjectMap() Returns the Simple Object Map
java.lang.String	getStoreName() Returns the name of the object store.
int	getStoreType() Gets the type of store this is, either a MdStore.MDSTORETYPE_SERVERSTORE or a MdStore.MDSTORETYPE_OBJECTSTORE
java.lang.String	getWriteBuffer() Get the string to be attached to the update write for this store.
boolean	is_write_lock()
boolean	isDeepCopyObjects() If deep copy has been turned on/off.
boolean	isDeletedObject(java.lang.String id) Returns true if the object is included in the store's deleted objects list
boolean	isGoToServerForMetadata() Tells whether or not to go to server for the metadata.
java.lang.String	makeID(java.lang.String shortID) Creates a new id for an object.
void	MdObjectsAdded(MdEvent e, java.util.List ids) NOT IMPLEMENTED
void	MdObjectsModified(MdEvent e, java.util.List items) We pass this event on to our listener.
void	MdObjectsRemoved(MdEvent e, java.util.List ids) NOT IMPLEMENTED
void	refreshObjectFromServer(CMetadata inObject, boolean includeLocallyChangedItems, boolean getFullObjectUpdate) Refreshes object from the server
void	refreshObjectFromServer(CMetadata inObject, boolean includeLocallyChangedItems, boolean getFullObjectUpdate, boolean refreshAssocsSetByServerOnly) Refreshes object from the server
void	refreshObjects(java.util.List<java.lang.String> items) Refreshes the following items from parent Map and tells children of update, fireMdObjectsModified()
void	refreshStoreFromServer(boolean includeLocallyChangedItems, boolean getFullObjectUpdate) Refreshes objects in this store from the server
void	removeElementFromChangeList(CMetadata object) Remove the specified element from the change list
void	removeElementFromStore(CMetadata removeObject)
void	removeElementFromStore(CMetadata removeObject, boolean removeDependents)
void	removeMdObjectListener(MdObjectListener l) Used to remove an object from the list of listeners for changes in the Metadata Map
void	removeMdStoreIDChangeListener(MdStoreIDChangeListener l) Used to remove an object from the list of listeners for changes in the Metadata Map
void	removeMdStoreListener(MdStoreListener l) Used to remove an object from the list of listeners for changes in the Metadata Map
void	removeObjectFromStore(CMetadata deleteObject, java.lang.String deleteTemplate) Removes an object from the store, marks it to delete, and uses a template to delete associated objects.
void	removeObjectsFromStore(java.util.List<? extends CMetadata> deletedObjects) Removes a set of objects from the store, and from server once store is persisted to server.
void	removeObjFromAuthorizationTransContextList(CMetadata obj) Remove an object from the Authorization Transaction Context List for this Store
void	removeStore(MdStore childStore) Removes a child store.
void	removeVetoableChangeListener(java.beans.VetoableChangeListener l) Removes a listener from the list of vetoable listners
void	resetStates(java.util.List<CMetadata> items) Resets all the objects in items to to set from server state or unSET.
CMetadata	restoreObject(java.lang.String objectID) Restores an object to the Store so that it is available from the store.
CMetadata	retrieveFullObject(java.lang.String objectType, java.lang.String objectID) Retrieves all metadata for an existing public object.
void	set_write_lock(boolean b) set write lock enabled.
void	setDeepCopyObjects(boolean copy) Sets if objects should be deep copied into this store.
void	setGoToServerForMetadata(boolean goToServer) Tells whether or not to go to server for the metadata.
void	setIsGotToServerForMetadata(boolean goToServer) Deprecated. setGoToServerForMetadata(boolean) should be used instead
void	setIsObjectCopiedFromParentOnCreation(boolean inValue) Sets whether new objects in this store are copied from thier parent on creation if the object exists in there parent store.
void	setNewObjectRepositoryID(java.lang.String newObjReposID) Deprecated. As of 9.2 this method is no longer supported
void	setObjectsToStale() Sets the state of all objects in the store to be "stale".
void	setOwningStore(MdStore parent) Sets the parent store to this one.
void	setProjectRepositoryID(java.lang.String projReposID) Deprecated. As of 9.2 this method is no longer supported
void	updateChangeListObjectIDs(java.lang.String OldReposID, java.lang.String NewReposID) Changes a new objects repos id for all the objects in the change list of this object store, to a specified repos id.
void	updateChangeListObjectIDs(java.lang.String OldReposID, java.lang.String NewReposID, java.lang.String targetReposID) Changes a new objects repos id for all the objects in the change list of this object store, to a specified repos id.
void	updateCreatedItemsList(java.util.List<java.lang.String> items) remove the items that have been updated from the createdItems list.
void	updatedMetadataAll() Updates objects in store to Metadata server.

Methods inherited from interface com.sas.metadata.remote.MdStore

addChildStore, isDisposed, removeChildStore

Method Detail

getFactory

MdFactory getFactory()
                     throws java.rmi.RemoteException

Returns the factory used to create objects.

Specified by:

getFactory in interface MdStore

Returns:

MdFactory

Throws:

java.rmi.RemoteException

getStoreType

int getStoreType()
                 throws java.rmi.RemoteException

Gets the type of store this is, either a MdStore.MDSTORETYPE_SERVERSTORE or a MdStore.MDSTORETYPE_OBJECTSTORE

Specified by:

getStoreType in interface MdStore

Returns:

store type as an int.

Throws:

java.rmi.RemoteException

getStoreName

java.lang.String getStoreName()
                              throws java.rmi.RemoteException

Returns the name of the object store. A null value is returned if a name wasn't provided.

Returns:

store name

Throws:

java.rmi.RemoteException

getIdentifier

java.lang.String getIdentifier()
                               throws java.rmi.RemoteException

Returns an identifier for this object store. This can be used to uniquely identify a particular object store within its owning factory. The identifier will be of the format "Store_NUM", where "NUM" is an integer.

Returns:

identifier

Throws:

java.rmi.RemoteException

isDeepCopyObjects

boolean isDeepCopyObjects()
                          throws java.rmi.RemoteException

If deep copy has been turned on/off. Default value is true.

Returns:

whether objects are being deep copied.

Throws:

java.rmi.RemoteException

setDeepCopyObjects

void setDeepCopyObjects(boolean copy)
                        throws java.rmi.RemoteException

Sets if objects should be deep copied into this store. The default value is true.

If set to false, only objects directly associated to the object being copied will be included. For instance, if an object named "X" is copied, only "X" and its associated objects will be copied. Any object indirectly associated to "X" will not be copied.

Parameters:

copy - false if deep copy should be turned off

Throws:

java.rmi.RemoteException

getIsGoToServerForMetadata

boolean getIsGoToServerForMetadata()
                                   throws java.rmi.RemoteException

Deprecated. isGoToServerForMetadata() should be used instead

Tells whether or not to go to server for the metadata.

Specified by:

getIsGoToServerForMetadata in interface MdStore

Returns:

boolean true if allowed to go to the server.

Throws:

java.rmi.RemoteException

isGoToServerForMetadata

boolean isGoToServerForMetadata()
                                throws java.rmi.RemoteException

Tells whether or not to go to server for the metadata.

Specified by:

isGoToServerForMetadata in interface MdStore

Returns:

boolean true if allowed to go to the server.

Throws:

java.rmi.RemoteException

setIsGotToServerForMetadata

void setIsGotToServerForMetadata(boolean goToServer)
                                 throws java.rmi.RemoteException

Deprecated. setGoToServerForMetadata(boolean) should be used instead

Tells whether or not to go to server for the metadata.

Specified by:

setIsGotToServerForMetadata in interface MdStore

Parameters:

goToServer - go for metadata

Throws:

java.rmi.RemoteException

setGoToServerForMetadata

void setGoToServerForMetadata(boolean goToServer)
                              throws java.rmi.RemoteException

Tells whether or not to go to server for the metadata.

Specified by:

setGoToServerForMetadata in interface MdStore

Parameters:

goToServer - go for metadata

Throws:

java.rmi.RemoteException

getIsObjectCopiedFromParentOnCreation

boolean getIsObjectCopiedFromParentOnCreation()
                                              throws java.rmi.RemoteException

Gets whether new objects in this store are copied fromt their parent on creation if the object exists in their parent store.

Returns:

boolean

Throws:

java.rmi.RemoteException

setIsObjectCopiedFromParentOnCreation

void setIsObjectCopiedFromParentOnCreation(boolean inValue)
                                           throws java.rmi.RemoteException

Sets whether new objects in this store are copied from thier parent on creation if the object exists in there parent store.

Parameters:

inValue -

Throws:

java.rmi.RemoteException

updatedMetadataAll

void updatedMetadataAll()
                        throws MdException,
                               java.rmi.RemoteException

Updates objects in store to Metadata server.

Specified by:

updatedMetadataAll in interface MdStore

Throws:

MdException - if there is an error in the updateMetadataAll call.

java.rmi.RemoteException

getProjectRepositoryID

java.lang.String getProjectRepositoryID()
                                        throws java.rmi.RemoteException

Deprecated. As of 9.2 this method is no longer supported

Returns the project Repository ID used for change management

Returns:

String the Repository id

Throws:

java.rmi.RemoteException

setProjectRepositoryID

void setProjectRepositoryID(java.lang.String projReposID)
                            throws java.rmi.RemoteException

Deprecated. As of 9.2 this method is no longer supported

Sets the project repos id

Parameters:

projReposID - String

Throws:

java.rmi.RemoteException

getNewObjectRepositoryID

java.lang.String getNewObjectRepositoryID()
                                          throws java.rmi.RemoteException

Deprecated. As of 9.2 this method is no longer supported

Sets the repos used for new objects created

Returns:

String repos id.

Throws:

java.rmi.RemoteException

setNewObjectRepositoryID

void setNewObjectRepositoryID(java.lang.String newObjReposID)
                              throws java.rmi.RemoteException

Deprecated. As of 9.2 this method is no longer supported

Sets the repos id used for new object.

Parameters:

newObjReposID - String

Throws:

java.rmi.RemoteException

setOwningStore

void setOwningStore(MdStore parent)
                    throws java.rmi.RemoteException

Sets the parent store to this one.

Specified by:

setOwningStore in interface MdStore

Parameters:

parent - MdStore

Throws:

java.rmi.RemoteException

getOwningStore

MdStore getOwningStore()
                       throws java.rmi.RemoteException

Gets the parent store to this one

Specified by:

getOwningStore in interface MdStore

Returns:

MdStore This store's parent.

Throws:

java.rmi.RemoteException

getDeletedObjects

java.util.Map<java.lang.String,CMetadata> getDeletedObjects()
                                                            throws java.rmi.RemoteException

Return a Map of the objects being deleted.

Returns:

Map objects that are not visible in this store.

Throws:

java.rmi.RemoteException

isDeletedObject

boolean isDeletedObject(java.lang.String id)
                        throws java.rmi.RemoteException

Returns true if the object is included in the store's deleted objects list

Parameters:

id - the object id

Returns:

true if being deleted

Throws:

java.rmi.RemoteException

getSimpleObjectMap

java.util.Map<java.lang.String,CMetadata> getSimpleObjectMap()
                                                             throws java.rmi.RemoteException

Returns the Simple Object Map

Returns:

The association Map

Throws:

java.rmi.RemoteException

getDetailObjectMap

java.util.Map<java.lang.String,CMetadata> getDetailObjectMap()
                                                             throws java.rmi.RemoteException

Returns the Detail Object Map

Specified by:

getDetailObjectMap in interface MdStore

Returns:

The association Map

Throws:

java.rmi.RemoteException

createRefreshXMLforStore

java.lang.String createRefreshXMLforStore(boolean includeLocallyChangedItems,
                                          boolean getFullObjectUpdate)
                                          throws java.rmi.RemoteException

Creates XML for all objects in store.

Specified by:

createRefreshXMLforStore in interface MdStore

Returns:

XML string for objects in store

Throws:

java.rmi.RemoteException

createXMLforStore

java.lang.String createXMLforStore()
                                   throws java.rmi.RemoteException

Creates XML for all objects in store.

Returns:

XML string for objects in store

Throws:

java.rmi.RemoteException

retrieveFullObject

CMetadata retrieveFullObject(java.lang.String objectType,
                             java.lang.String objectID)
                             throws MdException,
                                    java.rmi.RemoteException

Retrieves all metadata for an existing public object. A public object is defined as an object that has its PublicType attribute set with a matching entry in the type dictionary.

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 (MdOMIUtil.OMI_FULL_OBJECT, MdOMIUtil.OMI_ALL_SIMPLE, and MdOMIUtil.OMI_SUCCINCT) are automatically passed to the server for you.

Note: if the object exists within this store prior to calling this method, all of its attributes and associations will be overwritten.

Parameters:

objectType - the metadata type of the object

objectID - the object id

Returns:

the metadata object

Throws:

MdException

java.rmi.RemoteException

refreshStoreFromServer

void refreshStoreFromServer(boolean includeLocallyChangedItems,
                            boolean getFullObjectUpdate)
                            throws MdException,
                                   java.rmi.RemoteException

Refreshes objects in this store from the server

Parameters:

includeLocallyChangedItems - Includes the objects that have been changed locally

getFullObjectUpdate - Get all attributes and associations on all objects.

Throws:

MdException - If error going to the server

java.rmi.RemoteException - if I/O error

refreshObjectFromServer

void refreshObjectFromServer(CMetadata inObject,
                             boolean includeLocallyChangedItems,
                             boolean getFullObjectUpdate)
                             throws MdException,
                                    java.rmi.RemoteException

Refreshes object from the server

Parameters:

includeLocallyChangedItems - Includes the objects that have been changed locally

getFullObjectUpdate - Get all attributes and associations on all objects.

Throws:

MdException - If error going to the server

java.rmi.RemoteException - if I/O error

refreshObjectFromServer

void refreshObjectFromServer(CMetadata inObject,
                             boolean includeLocallyChangedItems,
                             boolean getFullObjectUpdate,
                             boolean refreshAssocsSetByServerOnly)
                             throws MdException,
                                    java.rmi.RemoteException

Refreshes object from the server

Parameters:

includeLocallyChangedItems - Includes the objects that have been changed locally

getFullObjectUpdate - Get all attributes and associations on all objects.

refreshAssocsSetByServerOnly - If true, refreshes only the associations that have previously been set by the server.

Throws:

MdException - If error going to the server

java.rmi.RemoteException - if I/O error

createExternalIdentityObject

void createExternalIdentityObject(CMetadata owningObject)
                                  throws java.rmi.RemoteException

Deprecated. As of 9.2 this method is no longer supported

This creates an ExternalIdentity object connection to owningObject for change management. This new object contains the real repos id for the new object.

Specified by:

createExternalIdentityObject in interface MdStore

Parameters:

owningObject - CMetadata Object to which to attach ExternalIdentity.

Throws:

java.rmi.RemoteException

deleteDetailMetadataObject

void deleteDetailMetadataObject(java.lang.String strFQID)
                                throws java.rmi.RemoteException

Deletes an object from the detail Map and fires the MetadataRemoved event.

Parameters:

strFQID - String

Throws:

java.rmi.RemoteException

makeID

java.lang.String makeID(java.lang.String shortID)
                        throws java.rmi.RemoteException

Creates a new id for an object.

Specified by:

makeID in interface MdStore

Parameters:

shortID - String

Returns:

String new id

Throws:

java.rmi.RemoteException

dumpDetailHashMap

void dumpDetailHashMap()
                       throws java.rmi.RemoteException

Prints out the contents of this MdObjectStore.

Specified by:

dumpDetailHashMap in interface MdStore

Throws:

java.rmi.RemoteException

dispose

void dispose()
             throws java.rmi.RemoteException

Cleans up this objectStore and it's objects from it's parent.

Specified by:

dispose in interface MdStore

Throws:

java.rmi.RemoteException

flushUpdates

void flushUpdates(java.util.List<CMetadata> updatedItems)
                  throws java.rmi.RemoteException

Flush updated objects to parent store. This cascades all the way to server store.

Specified by:

flushUpdates in interface MdStore

Parameters:

updatedItems - List The objects which have been updated to the server.

Throws:

java.rmi.RemoteException

removeStore

void removeStore(MdStore childStore)
                 throws java.rmi.RemoteException

Removes a child store.

Parameters:

childStore -

Throws:

java.rmi.RemoteException

getObject

CMetadata getObject(java.lang.String strFQID,
                    boolean hashonly)
                    throws java.rmi.RemoteException

Return object associated with ID

Parameters:

strFQID - String The ID of the object to get from the Map

hashonly - boolean get the object from this stores hash only.

Returns:

CMetadata The object, or null if object not in Map.

Throws:

java.rmi.RemoteException

getObject

CMetadata getObject(java.lang.String strFQID)
                    throws java.rmi.RemoteException

Return object associated with ID

Specified by:

getObject in interface MdStore

Parameters:

strFQID - String The ID of the object to get from the Map

Returns:

CMetadata The object, or null if object not in Map.

Throws:

java.rmi.RemoteException

changeHashKey

void changeHashKey(java.lang.String strOldId,
                   java.lang.String strNewId)
                   throws java.rmi.RemoteException

Change the hash key associated with an object, and send events for the removal of the old object and addition of the new object to Map.

Specified by:

changeHashKey in interface MdStore

Parameters:

strOldId - String

strNewId - String

Throws:

java.rmi.RemoteException

removeElementFromStore

void removeElementFromStore(CMetadata removeObject)
                            throws java.rmi.RemoteException

Removes an element from the changelist and removes all of its associations, then removes the object from the store all children stores and parent stores... It should remove this object everywhere except for the ServerStore. This should only be used on newly created objects in this store, to remove them totally from the client.

By default, all dependent objects of removeObjects (a Column and its Table, for instance), will be removed. If you do not wish to remove these dependent objects, see removeElementFromStore(CMetadata, boolean)

Parameters:

removeObject - CMetadata

Throws:

java.rmi.RemoteException

removeElementFromStore

void removeElementFromStore(CMetadata removeObject,
                            boolean removeDependents)
                            throws java.rmi.RemoteException

Removes an element from the changelist and removes all of its associations, then removes the object from the store all children stores and parent stores... It should remove this object everywhere except for the ServerStore. This should only be used on newly created objects in this store, to remove them totally from the client.

Any dependent objects of removeObject will be removed if removeDependents is set to True.

Parameters:

removeObject - CMetadata

Throws:

java.rmi.RemoteException

updateChangeListObjectIDs

void updateChangeListObjectIDs(java.lang.String OldReposID,
                               java.lang.String NewReposID)
                               throws java.rmi.RemoteException

Changes a new objects repos id for all the objects in the change list of this object store, to a specified repos id. This should be only the short ID. "AAAAAAAA" to "A5KE2N5K"

Specified by:

updateChangeListObjectIDs in interface MdStore

Parameters:

OldReposID - String The repos of objects when they were created.

NewReposID - String The project repos id if under change management, the target if not.

Throws:

java.rmi.RemoteException

updateChangeListObjectIDs

void updateChangeListObjectIDs(java.lang.String OldReposID,
                               java.lang.String NewReposID,
                               java.lang.String targetReposID)
                               throws java.rmi.RemoteException

Changes a new objects repos id for all the objects in the change list of this object store, to a specified repos id. This should be only the short ID. "AAAAAAAA" to "A5KE2N5K"

Specified by:

updateChangeListObjectIDs in interface MdStore

Parameters:

OldReposID - String The repos of objects when they were created.

NewReposID - String The project repos id if under change management, the target if not.

targetReposID - String In change management is the real repos the objects will be checked into

Throws:

java.rmi.RemoteException

refreshObjects

void refreshObjects(java.util.List<java.lang.String> items)
                    throws java.rmi.RemoteException

Refreshes the following items from parent Map and tells children of update, fireMdObjectsModified()

Parameters:

items - List

Throws:

java.rmi.RemoteException

resetStates

void resetStates(java.util.List<CMetadata> items)
                 throws java.rmi.RemoteException

Resets all the objects in items to to set from server state or unSET.

Specified by:

resetStates in interface MdStore

Parameters:

items - List (NOTE: CMetadata objects in items)

Throws:

java.rmi.RemoteException

setObjectsToStale

void setObjectsToStale()
                       throws java.rmi.RemoteException

Sets the state of all objects in the store to be "stale". The next time one of these objects is accessed through getObject(), it will be refreshed from the server.

Throws:

java.rmi.RemoteException

deleteObjectFromStore

void deleteObjectFromStore(java.lang.String strFQID)
                           throws java.rmi.RemoteException

Delete the object from this store and all object stores.

Parameters:

strFQID - String object to be deleted from client

Throws:

java.rmi.RemoteException

MdObjectsModified

void MdObjectsModified(MdEvent e,
                       java.util.List items)
                       throws java.rmi.RemoteException

We pass this event on to our listener. If they say to refresh then they will tell us to. We us a Vetoable change event to let a visual veto this change if we have any visuals to veto the change.

Specified by:

MdObjectsModified in interface MdStoreListener

Parameters:

e - MdEvent The metadata event source

items - List ID's of changed items.

Throws:

java.rmi.RemoteException

MdObjectsRemoved

void MdObjectsRemoved(MdEvent e,
                      java.util.List ids)
                      throws java.rmi.RemoteException

NOT IMPLEMENTED

Specified by:

MdObjectsRemoved in interface MdStoreListener

Parameters:

e - MdEvent

ids - List

Throws:

java.rmi.RemoteException

MdObjectsAdded

void MdObjectsAdded(MdEvent e,
                    java.util.List ids)
                    throws java.rmi.RemoteException

NOT IMPLEMENTED

Specified by:

MdObjectsAdded in interface MdStoreListener

Parameters:

e - MdEvent

ids - List

Throws:

java.rmi.RemoteException

addVetoableChangeListener

void addVetoableChangeListener(java.beans.VetoableChangeListener l)
                               throws java.rmi.RemoteException

Adds a listener to the list

Specified by:

addVetoableChangeListener in interface MdStore

Parameters:

l - VetoableChangeListener

Throws:

java.rmi.RemoteException

removeVetoableChangeListener

void removeVetoableChangeListener(java.beans.VetoableChangeListener l)
                                  throws java.rmi.RemoteException

Removes a listener from the list of vetoable listners

Specified by:

removeVetoableChangeListener in interface MdStore

Parameters:

l - VetoableChangeListener

Throws:

java.rmi.RemoteException

addMdStoreListener

void addMdStoreListener(MdStoreListener l)
                        throws java.rmi.RemoteException

Used to add an object to the list of listeners for changes in the Metadata Map

Specified by:

addMdStoreListener in interface MdStore

Parameters:

l - MetadataListener

Throws:

java.rmi.RemoteException

removeMdStoreListener

void removeMdStoreListener(MdStoreListener l)
                           throws java.rmi.RemoteException

Used to remove an object from the list of listeners for changes in the Metadata Map

Specified by:

removeMdStoreListener in interface MdStore

Parameters:

l - MetadataListener

Throws:

java.rmi.RemoteException

addMdObjectListener

void addMdObjectListener(MdObjectListener l)
                         throws java.rmi.RemoteException

Used to add an object to the list of listeners for changes in the Metadata Map

Parameters:

l - MetadataListener

Throws:

java.rmi.RemoteException

removeMdObjectListener

void removeMdObjectListener(MdObjectListener l)
                            throws java.rmi.RemoteException

Used to remove an object from the list of listeners for changes in the Metadata Map

Parameters:

l - MetadataListener

Throws:

java.rmi.RemoteException

addMdStoreIDChangeListener

void addMdStoreIDChangeListener(MdStoreIDChangeListener l)
                                throws java.rmi.RemoteException

Used to add an object to the list of listeners for changes in the Metadata Map

Parameters:

l - MetadataListener

Throws:

java.rmi.RemoteException

removeMdStoreIDChangeListener

void removeMdStoreIDChangeListener(MdStoreIDChangeListener l)
                                   throws java.rmi.RemoteException

Used to remove an object from the list of listeners for changes in the Metadata Map

Parameters:

l - MetadataListener

Throws:

java.rmi.RemoteException

deleteObject

boolean deleteObject(CMetadata inObject)
                     throws java.rmi.RemoteException

Makes an object unavailable in the object store. Use restore to make the object available after a delete

Specified by:

deleteObject in interface MdStore

Parameters:

inObject - CMetadata

Returns:

boolean if object was put in state deleted

Throws:

java.rmi.RemoteException

restoreObject

CMetadata restoreObject(java.lang.String objectID)
                        throws java.rmi.RemoteException

Restores an object to the Store so that it is available from the store.

Specified by:

restoreObject in interface MdStore

Parameters:

objectID - String

Returns:

CMetadata the object that was restored

Throws:

java.rmi.RemoteException

getChangedObjects

java.util.List<CMetadata> getChangedObjects()
                                            throws java.rmi.RemoteException

Gets a List of changed objects.

Specified by:

getChangedObjects in interface MdStore

Returns:

List , The Item that have changed.

Throws:

java.rmi.RemoteException

getNewObjects

java.util.List<CMetadata> getNewObjects()
                                        throws java.rmi.RemoteException

Gets a List of changed objects.

Returns:

List , The Item that have changed.

Throws:

java.rmi.RemoteException

addElementToChangeList

void addElementToChangeList(CMetadata object)
                            throws java.rmi.RemoteException

Adds the specified metadata object to this object's change list; only adds the object if it is not already in the list

Parameters:

object - The metadata object to add to the list

Throws:

java.rmi.RemoteException

removeElementFromChangeList

void removeElementFromChangeList(CMetadata object)
                                 throws java.rmi.RemoteException

Remove the specified element from the change list

Parameters:

object - Metadata object to remove. If the object does not exist in the list, this method just returns

Throws:

java.rmi.RemoteException

clearChangeList

void clearChangeList()
                     throws java.rmi.RemoteException

Remove all elements from the change list, and set it to empty

Throws:

java.rmi.RemoteException

getChangeList

java.util.Vector<CMetadata> getChangeList()
                                          throws java.rmi.RemoteException

Return the current change list

Returns:

Vector representing the list of elements on this object's change list

Throws:

java.rmi.RemoteException

getAuthorizationTransContextList

java.util.Vector<CMetadata> getAuthorizationTransContextList()
                                                             throws java.rmi.RemoteException

Returns:

Vector representing the list of elements on this object's Authorization Transaction Context List

Throws:

java.rmi.RemoteException

addObjToAuthorizationTransContextList

void addObjToAuthorizationTransContextList(CMetadata obj)
                                           throws java.rmi.RemoteException

Add an object to the Authorization Transaction Context List for this Store

Throws:

java.rmi.RemoteException

removeObjFromAuthorizationTransContextList

void removeObjFromAuthorizationTransContextList(CMetadata obj)
                                                throws java.rmi.RemoteException

Remove an object from the Authorization Transaction Context List for this Store

Throws:

java.rmi.RemoteException

clearAuthorizationTransContextList

void clearAuthorizationTransContextList()
                                        throws java.rmi.RemoteException

Clear the Authorization Transaction Context List for this Store

Throws:

java.rmi.RemoteException

removeObjectsFromStore

void removeObjectsFromStore(java.util.List<? extends CMetadata> deletedObjects)
                            throws MdException,
                                   java.rmi.RemoteException

Removes a set of objects from the store, and from server once store is persisted to server.

Parameters:

deletedObjects - list of CMetadata objects

Throws:

MdException

java.rmi.RemoteException

removeObjectFromStore

void removeObjectFromStore(CMetadata deleteObject,
                           java.lang.String deleteTemplate)
                           throws MdException,
                                  java.rmi.RemoteException

Removes an object from the store, marks it to delete, and uses a template to delete associated objects.

If a template is supplied, then this method will only remove the objects specified in the template. Dependent objects will only be removed if a template is not passed in (if the deleteTemplate is null or empty).

Parameters:

deleteObject - the object to delete

deleteTemplate - the template, null will n

Throws:

MdException

java.rmi.RemoteException

clearWriteBuffer

void clearWriteBuffer()
                      throws java.rmi.RemoteException

Clear write append buffer out

Throws:

java.rmi.RemoteException

getWriteBuffer

java.lang.String getWriteBuffer()
                                throws java.rmi.RemoteException

Get the string to be attached to the update write for this store.

Returns:

String containing the write XML

Throws:

java.rmi.RemoteException

appendWriteBuffer

void appendWriteBuffer(java.lang.String appendText)
                       throws java.rmi.RemoteException

Append the text to the write buffer for this store.

Parameters:

appendText - the text to append to the write buffer.

Throws:

java.rmi.RemoteException

getCreatedItemsList

java.util.List<java.lang.String> getCreatedItemsList()
                                                     throws java.rmi.RemoteException

Returns the list of items created in current write.

Returns:

List

Throws:

java.rmi.RemoteException

updateCreatedItemsList

void updateCreatedItemsList(java.util.List<java.lang.String> items)
                            throws java.rmi.RemoteException

remove the items that have been updated from the createdItems list.

Specified by:

updateCreatedItemsList in interface MdStore

Parameters:

items -

Throws:

java.rmi.RemoteException

clearObjectsFromStore

void clearObjectsFromStore()
                           throws java.rmi.RemoteException

Remove all non-deleted objects from the store and usage... **Note: doesn't handle deleted objects.

Throws:

java.rmi.RemoteException

is_write_lock

boolean is_write_lock()
                      throws java.rmi.RemoteException

Returns:

lock write enabled.

Throws:

java.rmi.RemoteException

set_write_lock

void set_write_lock(boolean b)
                    throws java.rmi.RemoteException

set write lock enabled.

Parameters:

b -

Throws:

java.rmi.RemoteException